Наиболее распространенный докблок для кода Delphi и / или FreePascal - PullRequest
Новая
       34

Наиболее распространенный докблок для кода Delphi и / или FreePascal

7 голосов
/ 15 апреля 2009

Я хорошо знаком с док-блоками PHP, так как это моя работа в течение последних 15 с лишним лет. 

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

Я пытаюсь понять, есть ли такой стандарт для Delphi и / или FreePascal.

Из моего анализа ужасного количества кода я никогда не видел ни одного, но могу ошибаться.

Ответы [ 6 ]

15 голосов
/ 15 апреля 2009

Инструменты документирования Delphi

Использование инструмента XMLDoc для документации API и HelpInsight с Delphi 2005 http://edn.embarcadero.com/article/32770

XML-документация в Delphi 2006 http://tondrej.blogspot.com/2006/03/xml-documentation-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 - просто еще один DelphiDoc http://delphidoc.sourceforge.net/

Обсуждение Stackoverflow

Существует ли документатор кода Delphi, который поддерживает текущий синтаксис Delphi? https://stackoverflow.com/questions/673248/is-there-a-delphi-code-documentor-that-supports-current-delphi-syntax

Документация по коду для delphi, похожая на javadoc или c # xml doc Документация по коду для delphi, аналогичная javadoc или c # xml doc

Документирование Delphi https://stackoverflow.com/questions/33336/documenting-delphi

7 голосов
/ 15 апреля 2009

Последние Delphis поддерживают анализ XML-документации. Они также используют эту информацию в подсказках (например, при наведении курсора мыши на имя метода).

Я использую этот шаблон для документации метода: 

///<summary></summary>
///<param name=''></param>
///<returns></returns>
///<exception cref=""></exception>
///<since>2009-04-15</since>
1 голос
/ 26 апреля 2009

Я предпочитаю документы за пределами источника (они всегда запутываются) и использую отличный fpdoc, который поставляется с FPC. (В нем написаны собственные документы FPC).

1 голос
/ 15 апреля 2009

В проекте, над которым я сейчас работаю, мы используем DelphiCodeToDoc , который работает достаточно хорошо. Его синтаксис выглядит так: 

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;
1 голос
/ 15 апреля 2009

Похоже, что у doxygen есть инструмент , который можно использовать вместе с документами Pascal и Delphi с кодом . Может быть, это поможет вам.

0 голосов
/ 15 апреля 2009

Существует несколько стандартов, обычно в зависимости от используемого инструмента документации. Мы используем PasDoc, поэтому в основном придерживаемся его формата http://pasdoc.sipsolutions.net/, основанного на JavaDoc.

В качестве альтернативы есть XMLDoc, как указал Габр, и есть довольно много других инструментов, большинство из которых имеют схожий синтаксис с небольшими различиями.

...