Ich bin auf der Suche nach einem Tool zum Erstellen von Delphi-Quellcode-Dokumentation, und ich möchte versuchen, Doc-O-Matic Express (die frei ist). Gibt es Richtlinien für Anfänger, wie man Doc-O-Matic Express zur Dokumentation von Delphi-Quellcode verwendet (Verwaltung von doc-o-matic-Projekten, bevorzugter Docblock-Stil, vollständige Docblock-Syntax usw.)?Verwendung von Doc-O-Matic (Express) mit Delphi
In diesem page können Sie ein Dokument finden, das für Sie nützlich sein kann Delphi Documentation Guidelines. Ich habe diese Richtlinien verwendet, um meinen Quellcode in diesem project zu dokumentieren.
Stören Sie nicht die Doc-o-matic-Einstellungen. Die Express Edition ist nur eine Befehlszeile.
Doc-o-matic Kommentar unterstützen JavaDoc und XMLDoc (oder sogar Art von nativen Kommentaren). Das Tool it-sel wird nur helfen, wenn Ihr Code bereits ein Kommentar ist, oder wenn Sie direkt in seiner IDE kommentieren möchten.
Wenn Sie XML-Doc oder JavaDoc, Doc-O-Matic beide gleichermaßen gut unterstützt und sind alle drei Modelle sind unterstützt, wenn Quelle durch den integrierten Editor zurück zur der Quelle Kommentare zu schreiben.
Nur für nichtkommerziellen Gebrauch. –
Doc-O-Matic als Tool ist wirklich sehr gut, aber am Ende ist die Qualität Ihrer Dokumentation nur so gut wie die Mühe, die Sie in die Kommentierung Ihres Codes investiert haben. –
Sie können DelphiCodeToDoc ausprobieren (Opensource-Software, die mit Delphi geschrieben wurde). Das Erstellen eines ersten Projekts ist eine Angelegenheit von Sekunden. Danach, wenn Sie mehr "professionelle" Funktionen benötigen, versuchen Sie es mit Doc-o-matic (was SEHR mächtig ist). http://dephicodetodoc.sourceforge.net/ – TridenT