Häufigster Docblock für Delphi- und / oder FreePascal-Code

7

Ich bin mit PHP-Dockblocks ziemlich vertraut, da es in den letzten 15 Jahren mein Job war.

%Vor%

Was ich versuche zu verstehen, ist, ob es einen Standard wie Delphi und / oder FreePascal gibt.

Aus meiner Analyse über eine Menge Code habe ich nie etwas gesehen, aber ich könnte tot falsch liegen.

    
Gustavo Carreno 15.04.2009, 08:41
quelle

6 Antworten

15

Delphi Dokumentationswerkzeuge

Verwenden des XMLDoc-Tools für die API-Dokumentation und HelpInsight mit Delphi 2005 Ссылка

XML-Dokumentation in Delphi 2006 Ссылка

DelphiCodeToDoc Ссылка

Doc-O-Matic Ссылка

PasDoc Ссылка

Pascal Browser Ссылка

Doxygen Ссылка

Pas2Dox Ссылка

JADD - Nur noch ein DelphiDoc Ссылка

Stackoverflow-Diskussion

Gibt es einen Delphi-Codedokumentor, der die aktuelle Delphi-Syntax unterstützt? Gibt es einen Delphi-Code-Documentor, der aktuelle Delphi unterstützt? Syntax?

Codedokumentation für Delphi ähnlich wie javadoc oder c # xml doc Code-Dokumentation für Delphi ähnlich wie javadoc oder c # xml doc

Dokumentieren von Delphi Dokumentieren von Delphi

    
user81864 15.04.2009, 09:49
quelle
7

Neueste Delphis unterstützen das Parsen von XML-Dokumentation. Sie verwenden diese Informationen auch in Hinweisen (z. B. wenn Sie den Mauszeiger über einen Methodennamen bewegen).

Ich verwende diese Vorlage für die Methodendokumentation:

%Vor%     
gabr 15.04.2009 08:53
quelle
1

Doxygen hat anscheinend ein Tool , das in Verbindung mit document Pascal und Delphi-Code . Vielleicht hilft dir das.

    
1800 INFORMATION 15.04.2009 08:49
quelle
1

Ich bevorzuge Dokumente außerhalb der Quelle (es wird immer unordentlich), und benutze das ausgezeichnete fpdoc, das mit FPC kommt. (FPCs eigene Dokumente sind darin geschrieben).

    
Marco van de Voort 26.04.2009 17:14
quelle
1

In einem Projekt, an dem ich gerade arbeite, verwenden wir DelphiCodeToDoc , was ziemlich gut funktioniert. Die Syntax sieht folgendermaßen aus:

%Vor%     
onnodb 15.04.2009 09:18
quelle
0

Es gibt verschiedene Standards, die normalerweise vom verwendeten Dokumentationswerkzeug abhängen. Wir verwenden PasDoc, daher halten wir uns hauptsächlich an das Format Ссылка , das auf JavaDoc basiert.

Alternativ gibt es XMLDoc, wie es von gabr gezeigt wurde, und es gibt einige andere Werkzeuge, von denen die meisten eine ähnliche Syntax mit feinen Unterschieden haben.

    
dummzeuch 15.04.2009 14:18
quelle