Das häufigste Docblock für Delphi und/oder Freepascal Code

Question

Ich bin mit PHP -Dockblocks sehr vertraut, da es seit mehr als 15 Jahren mein Job war.

/**
  * Description
  *
  * @tag bla bla
  * @tag more bla bla
  */

Ich versuche zu verstehen, ob es einen solchen Standard für Delphi und/oder Freepascal gibt.

Aus meiner Analyse zu einem schrecklichen Code habe ich nie gesehen, aber ich könnte total falsch sein.

Answer 1

Delphi -Dokumentationstools

Verwenden des XMLDOC -Tools für API -Dokumentation und HelpinSight mit Delphi 2005http://edn.embarcadero.com/article/32770

XML -Dokumentation in Delphi 2006http://tondrej.blogspot.com/2006/03/xml-documentation-in-delphi-2006.html

Delphicodetodochttp://dephicodetodoc.sourceforge.net/

Doc-o-matichttp://www.doc-o-matic.com/examplesourcecode.html

Pasdochttp://pasdoc.sipsolutions.net/

Pascal -Browserhttp://www.pegeganza.com/

Doxygenhttp://www.doxygen.nl/

Pas2doxhttp://sourceforge.net/projects/pas2dox/

Jadd - nur ein weiterer Delphidochttp://delphidoc.sourceforge.net/

Stackoverflow -Diskussion

Gibt es einen Delphi -Code -Dokumentor, der die aktuelle Delphi -Syntax unterstützt?https://stackoverflow.com/questions/673248/is-there-a-delphi-code-documentor-that-supports-current-delphi-syntax

Code -Dokumentation für Delphi ähnlich wie Javadoc oder C# xml docCode -Dokumentation für Delphi ähnlich wie Javadoc oder C# xml doc

Dokumentation von Delphihttps://stackoverflow.com/questions/33336/documenting-delphi

Answer 2

Die neueste Delphis unterstützt die Analyse der XML -Dokumentation. Sie verwenden diese Informationen auch in Hinweisen (z. B. wenn Sie den Mauszeiger über einen Methodennamen verschieben).

Ich verwende diese Vorlage für die Methodendokumentation:

///<summary></summary>
///<param name=''></param>
///<returns></returns>
///<exception cref=""></exception>
///<since>2009-04-15</since>

Answer 3

Ich bevorzuge Dokumente außerhalb der Quelle (es wird immer chaotisch) und benutze das exzellente FPDOC, das mit FPC geliefert wird. (Die eigenen Dokumente des FPC sind darin geschrieben).

Answer 4

Bei einem Projekt, an dem ich gerade arbeite, verwenden wir Delphicodetodoc, was einigermaßen gut funktioniert. Die Syntax sieht so aus:

type
  {* This is an example class }
  TMyClass = class
  private
  protected
  public
    {* Does some twiddling with AParam, and returns the result as String
       @param AParam Input value
       @return AParam incremented by 2, as String
       @throws Exception 'Boo' if it's full moon }
    function MyFunction(AParam: Integer): String;
  end;

Answer 5

Es sieht so aus, als hätte Doxygen ein Werkzeug die in Verbindung mit verwendet werden können Dokumentieren Sie Pascal- und Delphi -Code. Vielleicht hilft dir das.

Answer 6

Es gibt mehrere Standards, die normalerweise vom verwendeten Dokumentationstool abhängen. Wir verwenden Pasdoc, also halten wir hauptsächlich an sein Format fest http://pasdoc.sipsolutions.net/ das basiert auf Javadoc.

Alternativ gibt es XMLDOC, auf die GABR betonte, und es gibt noch einige andere Tools, die die meisten ähnliche Syntax mit subtilen Unterschieden aufweisen.