Lotus Notes / Domino Sonstiges > Tools & Downloads

Dokumentation von Scriptcode

(1/4) > >>

bikerboy:
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, aber irgendwie komm ich damit nicht zurecht.


Wäre also froh wenn ihr noch was habt.

Gruss und besten Dank

Driri:
Wir benutzen den Teamstudio Analyzer.

Brocki:
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

flaite:
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

jBubbleBoy:
@Axel
Was für ein Tool habt Ihr im Einsatz? Teamstudio Code-Sniper oder Eigenbau?

bubble

Navigation

[0] Themen-Index

[#] Nächste Seite