Docblock le plus courant pour Delphi et / ou Code Freepascal

Question

Je connais bien les docks PHP car c'est mon travail depuis plus de 15 ans.

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

Ce que j'essaie de comprendre, c'est s'il y a une norme comme celle pour Delphi et / ou Freepascal.

D'après mon analyse sur beaucoup de code, je n'en ai jamais vu, mais je pourrais me tromper.

Answer 1

Outils de documentation Delphi

Utilisation de l'outil XMLDOC pour la documentation de l'API et HelpInsight avec Delphi 2005http://edn.embarcadero.com/article/32770

Documentation XML dans 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/

Navigateur Pascalhttp://www.peganza.com/

Doxygènehttp://www.doxygen.nl/

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

JADD - Juste un autre Delphidochttp://delphidoc.sourceforge.net/

Discussion Stackoverflow

Existe-t-il un documentant de code Delphi qui prend en charge la syntaxe actuelle Delphi?https://stackoverflow.com/questions/673248/is-there-a-delphi-code-documentor-that-supports-current-delphi-syntax

Documentation du code pour Delphi similaire à Javadoc ou C # XML DocDocumentation du code pour Delphi similaire à Javadoc ou C # XML Doc

Documenter Delphihttps://stackoverflow.com/questions/33336/Documentation-delphi

Answer 2

Dernier analyse de support Delphis de la documentation XML. Ils utilisent également ces informations dans des conseils (par exemple si vous déplacez le curseur de la souris sur un nom de méthode).

J'utilise ce modèle pour la documentation de la méthode:

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

Answer 3

Je préfère les documents en dehors de la source (il devient toujours désordonné) et j'utilise l'excellent FPDOC fourni avec FPC. (Les propres documents de FPC y sont écrits).

Answer 4

Sur un projet sur lequel je travaille actuellement, nous utilisons Delphicodetodoc, ce qui fonctionne assez bien. Sa syntaxe ressemble à ceci:

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

Il semble que le doxygen ait un outil qui peut être utilisé en conjonction à Documenter le code Pascal et Delphi. Peut-être que cela vous aidera.

Answer 6

There are several standards, usually depending on the documentation tool being used. We use PasDoc, so we adhere mostly to its format http://pasdoc.sipsolutions.net/ which is based on JavaDoc.

Alternatively, there is XMLDoc as gabr pointed out and there are quite a few other tools, most having similar syntax with subtle differences.