La maggior parte docblock comune per Delphi e / o codice FreePascal

Question

Sono abbastanza familiarità con PHP dockblocks dal momento che è stato il mio lavoro per gli ultimi 15+ anni.

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

Quello che sto cercando di capire è se c'è uno standard del genere per Delphi e / o FreePascal.

Dalla mia analisi su un sacco di codice che ho mai visto nessuno, ma potrei essere morto sbagliato.

Answer 1

Delphi strumenti di documentazione

Utilizzando lo strumento XMLDoc per la documentazione API ed HelpInsight con Delphi 2005 http://edn.embarcadero.com/article/32770

La documentazione XML in Delphi 2006 http://tondrej.blogspot.com/2006/ 03 / xml-documentazione-in-Delphi-2006.html

DelphiCodeToDoc http://dephicodetodoc.sourceforge.net/

Doc-O-Matic http://www.doc-o-matic.com/examplesourcecode.html

pasdoc http://pasdoc.sipsolutions.net/

Pascal Browser http://www.peganza.com/

Doxygen http://www.doxygen.nl/

Pas2Dox http://sourceforge.net/projects/pas2dox/

Jadd - Just Another DelphiDoc http://delphidoc.sourceforge.net/

discussione StackOverflow

C'è un codice documentato Delphi che supporta la sintassi Delphi attuale? https://stackoverflow.com/questions/ 673.248 / è-ci-a-Delphi-codice-documentato-che-sostiene-corrente-Delphi-sintassi

documentazione del codice per Delphi simile a javadoc o C # XML doc per Delphi simile a javadoc oppure c # xml doc

La documentazione Delphi https://stackoverflow.com/questions/33336/documenting-delphi

Answer 2

Ultime Delphis sostegno parsing di documenti XML. Essi hanno inoltre utilizzare queste informazioni in suggerimenti (ad esempio se si sposta il cursore del mouse sul nome di un metodo).

Sto usando questo modello per la documentazione metodo:

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

Answer 3

Io preferisco documenti al di fuori della fonte (si arriva sempre disordinato), e utilizzare l'eccellente fpdoc che viene fornito con FPC. (Propri documenti di FPC sono scritti in esso).

Answer 4

In un progetto che sto attualmente lavorando, stiamo usando DelphiCodeToDoc , che funziona ragionevolmente bene . La sua sintassi è simile al seguente:

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

Sembra doxygen ha un strumento che può essere utilizzato in combinazione per documento Pascal e Delphi codice . Forse che vi aiuterà.

Answer 6

Ci sono diversi standard, di solito a seconda del strumento di documentazione in uso. Usiamo pasdoc, quindi ci atteniamo per lo più in formato la sua http://pasdoc.sipsolutions.net/ che è sulla base di JavaDoc.

In alternativa, v'è XMLDoc come gabr rilevare e ci sono parecchi altri strumenti, più avendo sintassi simile con sottili differenze.