Das Notes Forum
Lotus Notes / Domino Sonstiges => Tools & Downloads => Thema gestartet von: bikerboy am 28.08.07 - 14:39:22
-
Hallo ich bin auf der Suche nach einem Tool tool zur dokumentation von scriptcode, analog zu javadocs für javacode
Habt ihr da was ? Das einzige was ich bis jetzt gefunden habe ist www.lsdoc.org (http://www.lsdoc.org), aber irgendwie komm ich damit nicht zurecht.
Wäre also froh wenn ihr noch was habt.
Gruss und besten Dank
-
Wir benutzen den Teamstudio Analyzer.
-
Eigentlich funktioniert ist es ganz einfach.
Einfach die "lsdoc_120.ntf" herunterladen und daraus eine eigene DB erstellen.
Danach das Konfigurationsdokument ausfüllen.
Von der Ansicht das Konfigurationsdokument auswählen und den Agenten "Build Lotusscript.doc" ausführen.
Wichtig!! Dein Code sollte die entsprechenden Beschreibungstags in den Kommentaren enthalten.
Du startest lokal den "nhttp.exe" (Webservice) Task und dann kannst Du die über den Browser die Doku Deines Scriptcodes anschauen.
Hier der Link zur Doku:
http://www.lsdoc.org/webcm/lsdoc_org.nsf/0/lsdoc_usermanual
Hier die Syntax der Beschreibungstags, damit der Buildprocess dein Code durchparsen kann:
http://www.lsdoc.org/webcm/lsdoc_org.nsf/0/lsdoc_syntax
Falls Du noch Fragen hast, ich schaue von Zeit zu Zeit hier mal rein.
Grüße Brocki
-
Ich find LS-doc auch sinnvoll. Für nicht-Framework-Code sehe ich zwar den Vorteil einer externen HTML-Dokumentation in JavaDoc Stil nicht wirklich, aber zumindest führt das dazu, dass die Team-Mitglieder in einem einigermassen konsistenten Stil ihren Code beschreiben.
Sinnvoll ist dabei ein Smarticon zu haben, dass Funktionen mit Errorhandling-Code und Kommentaren erzeugt. Wir haben das hier. Irgendwo im Internet ist es beschrieben. Ansonsten wär mir das zu viel Tipparbeit (und ich kann schnell tippen).
Ich glaub der Code selbst ist ein gutes Beispiel für dxl mit xslt. So tief hab ich mir das aber noch nicht angeschaut. Will aber.
Gruß Axel
-
@Axel
Was für ein Tool habt Ihr im Einsatz? Teamstudio Code-Sniper oder Eigenbau?
bubble
-
Hmm habe nun das Prog doch endlich mal zum Laufen bekommen, aber toll finde ich es trotzdem nicht. Die Tools von teamstudio sind meistens sehr gut, aber leider auch teuer.
@Diri kannst du mir so ein paar vorzüge nennen ? Ich habe mal gehört das eins der tools auch deinen Code bewertet, ist das der Fall ?
-
noch nichts. wir suchen halt was fähiges
-
Der Analyzer hat eine Auditfunktion. Man kann Filter definieren (z.B. in Formelsprache) und diese Filter dann auf Datenbanken loshetzen. Somit kann man Datenbanken auf bekannte Problemfälle hin prüfen.
Diese Auditfunktion ist sehr mächtig. Teamstudio bietet z.B. Filtersets an, mit denen man Datenbanken vor einer Migration auf ein neues Dominorelease auf Kompatibilität testen kann. Die Dokumentation des Codes ist nur eine Funktion des Analyzers.
-
Diri, aber ein Audit/Delta ist nicht Dokumentation. Mit Ciao bekommich auch eine schöne Änderungshistorie, aber Doku ist das keine.
@bikerboy: Solange Du die Kommentare im Code nicht an lsdoc angepasst hast, bringst auch nicht viel. ;)
-
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. Ich glaube Teamstudio ist da die bessere Wahl oder gibt es auf dem Markt noch mehr ? Google war in diesem Fall mal sehr ahnunglslos.
-
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.
LOL. Na dann definier doch mal, was es "mehr"/anders können soll?
JavaDoc is ja auch nix anderes: Javadoc ist ein Software-Dokumentationswerkzeug, das aus Java-Quelltexten automatisch HTML-Dokumentationsdateien erstellt.
-
Diri, aber ein Audit/Delta ist nicht Dokumentation. Mit Ciao bekommich auch eine schöne Änderungshistorie, aber Doku ist das keine.
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.
-
Aber wenn man ordentlich im Code dokumentiert, hat man dann schon recht viel.
Ja, dann schon. :)
-
<whippersnapper>
Wer viel dokumentiert hat stets eine umfangreiche Dokumentation
</whippersnapper>
;D
-
@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
-
Ich fragte, weil ich mich mit diesem Thema schon mal beschäftigt habe. Smarticons (Formel) können wie folgt Code z.B. LS ausführen:
1) DB öffnen, Agenten starten, Problem eine DB wird geöffnet --> neuer Tab.
2) Mit @command([Compose]...), Problem geht nur im NotesClient, d.h aus dem Designer heraus wird zuerst der NotesClient in den Vordergrund geholt.
3) Über C-API (DLL-Verteilung), wird z.B. bei TeamStudio so gemacht, Problem ich habe keinerlei Erfahrung mit der Sprache C.
Kannst Du mal nachsehen was für ein Code in deinem Smarticon steht?
bubble