Quellcode-DokumentationIch verwende derzeit NaturalDocs, um automatisch eine HTML-basierte Dokumentation des von mir geschriebenen JSL-Codes zu generieren.Ich arbeite ziemlich gut mit einfachem Kommentar-Markup im Code:
Ich richte gerade eine neue Entwicklungsumgebung ein und es ist eine Gelegenheit, die Tools in meinem Workflow zu überprüfen.Ich habe mich nur gefragt, ob jemand andere Gedanken zu Tools zur Dokumentationserstellung für JSL hat?
Betreff: Quellcode-DokumentationIch habe es gerade auf einem neuen PC installiert – im Anhang finden Sie eine Beschreibung des Vorgangs
Betreff: Quellcode-Dokumentation@uday_guntupalli Ich werde es jetzt auf einem neuen Computer installieren.Gerne dokumentiere und teile ich den Vorgang, sobald er abgeschlossen ist (ich musste die Konfiguration erweitern, um die JSL-Sprache zu verarbeiten).
Betreff: Quellcode-Dokumentation@David_Burnham ,
Ich habe versucht, dem Beispiel zu folgen und Natural Docs zu installieren. Nachdem Sie es wie hier beschrieben eingerichtet haben ( http://www.naturaldocs.org/getting_started/getting_set_up/#starting_a_new_project ) , wenn ich versuche, configure auszuführen, um Dokumentation zu generieren, erhalte ich Folgendes
Allerdings habe ich wie angewiesen den Eingabeordner und den Ausgabeordner bereitgestellt. Haben Sie eine Idee, was ich falsch gemacht habe?
Betreff: Quellcode-DokumentationNaturalDocs sieht sehr interessant aus.Vielen Dank, dass Sie uns darauf aufmerksam gemacht haben!
Kleiner Zweig zu dieser Diskussion: Hier sind einige Open-Source-Dienstprogramme, die ich für die Programmentwicklung unverzichtbar halte:
TortoiseSVN : H elps-Programmierer verwalten verschiedene Versionen des Quellcodes für ihre Programme (Quellcode-Kontrollsystem).Apache™ Subversion (SVN)®-Client, implementiert als Windows-Shell-Erweiterung.
Notizblock++: Windows Notepad zu Steroiden.Syntaxkolorierung für die meisten Sprachen.
Kdiff3: Windows-basiertes Diff-Programm.Ideal zum Auffinden und Zusammenführen von Unterschieden zwischen zwei oder drei Dateien oder Verzeichnissen.
Betreff: Quellcode-DokumentationIch habe diesen Weg mit DOxygen begonnen (ich verwende ein Spin-off, roxygen2, ausgiebig in R), bin aber nicht weit genug gekommen, um etwas mit JSL bereitzustellen. NaturalDocs scheint gut zu passen.
