@Axel
Was für ein Tool habt Ihr im Einsatz? Teamstudio Code-Sniper oder Eigenbau?
bubble
Wir benutzen LS-Doc von Mikkel Heisterberg.
Und weil ich an all-things-agile-lean-xp-and-scrum glaube, find ich dass das Hauptaugenmerk darauf gerichtet werden muß, es dem Entwickler (also im Zweifelsfall oft mir) möglichst einfach gemacht werden
MUSS.
Das Problem von Dokumentation ist nämlich, dass die Erstellung/Änderung leicht einfach zu umständlich ist. Das wird dann 2 Wochen durchgehalten und danach wird dann mit dem Kopf gewackelt und ja eigentlich sollte man ja aber jaja oder hihi. Projektmanager der sehr alten Schule jammern dann gerne noch über undisziplinierte Entwickler. Sie selbst sind aber stolz darauf, dass sie seit 10 Jahren keinen code mehr geschrieben haben. Solche Dummheit hab ich leider oft erlebt.
Tools sind eigentlich nicht sooo wichtig. Wichtig ist der Prozess.
Wenn ein Prozess nicht funktioniert, sollte man sich erst mal über die Menschenkompatibilität des Prozesses nachdenken und nicht über die Kompatibilität der Menschen für den Prozess. Mag ein Vorurteil sein, aber aus meiner Erfahrung neigen gerade viele Leute mit Ingenieursausbildung dazu, dies in diesem Leben nicht mehr zu verstehen.
Man muss es möglichst einfach machen. Deshalb ist hier die Geschichte mit dem Smart-Icon sehr praktisch, die nix mit LS-Doc zu tun hat. Ich klick da drauf und bekomme eine Liste an Code-Templates angezeigt. Und das wichtigste heisst Function with ls-doc and errorhandling. Ich klick da drauf und bekomm schon mal eine Funktion mit lsDoc-Dokumentation drüber und Errorhandling in der Funktion. Kann das nicht rausschicken, aber das gibts irgendwo im Internet (weiss nicht wo).
Gruß Axel