Lotus Notes / Domino Sonstiges > Tools & Downloads
Dokumentation von Scriptcode
m3:
--- Zitat von: bikerboy am 28.08.07 - 15:53:02 ---hmm also vielleicht bin ich auch mit falschen erwartungen an die Suche nach so einem Tool gegangen. Aber das Tool macht ja nichts anderes als mir meine Kommentare, wenn ich sie richtig geschrieben habe , rauszufiltern, dann legt es noch eine Struktur fest durch die ich navigieren kann.
--- Ende Zitat ---
LOL. Na dann definier doch mal, was es "mehr"/anders können soll?
JavaDoc is ja auch nix anderes:
--- Zitat ---Javadoc ist ein Software-Dokumentationswerkzeug, das aus Java-Quelltexten automatisch HTML-Dokumentationsdateien erstellt.
--- Ende Zitat ---
Driri:
--- Zitat ---Diri, aber ein Audit/Delta ist nicht Dokumentation. Mit Ciao bekommich auch eine schöne Änderungshistorie, aber Doku ist das keine.
--- Ende Zitat ---
Wieso ? Ich kann doch mit dem Analyzer eine komplette Analyse (mir fällt gerade kein anderes Wort ein) einer Datenbank erstellen. Daß das keine vollwertige Doku ist, ist mir auch klar. Aber wenn man ordentlich im Code dokumentiert, hat man dann schon recht viel.
m3:
--- Zitat von: Driri am 28.08.07 - 16:18:31 ---Aber wenn man ordentlich im Code dokumentiert, hat man dann schon recht viel.
--- Ende Zitat ---
Ja, dann schon. :)
eknori:
<whippersnapper>
Wer viel dokumentiert hat stets eine umfangreiche Dokumentation
</whippersnapper>
;D
flaite:
--- Zitat von: jBubbleBoy am 28.08.07 - 15:34:34 ---@Axel
Was für ein Tool habt Ihr im Einsatz? Teamstudio Code-Sniper oder Eigenbau?
bubble
--- Ende Zitat ---
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
Navigation
[0] Themen-Index
[#] Nächste Seite
[*] Vorherige Sete
Zur normalen Ansicht wechseln