الأكثر شيوعا Docblock ل Delphi و / أو رمز FreePascal

Question

أنا معتاد جدا على PHP Dockblocks لأنها كانت وظيفتي لمدة 15 عاما الماضية.

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

ما أحاول فهمه هو إذا كان هناك معيار من هذا القبيل بالنسبة ل Delphi و / أو Freepascal.

من تحليلي على الكثير من التعليمات البرمجية التي لم أرها أبدا، ولكني يمكن أن أكون خاطئا.

Answer 1

أدوات وثائق دلفي

باستخدام أداة XMLDOC لتوثيق API وسيدتي مع دلفي 2005http://edn.embarcadero.com/article/32770.

مستندات XML في دلفي 2006http://tondrej.blogspot.com/2006/03/xml-documentation-in-delphi-2006.html

delphicodetetodoc.http://dephicodetodoc.sourceforge.net/

Doc-O- ماتيكhttp://www.doc-o-matic.com/examplesourcecode.html.

Pasdoc.http://pasdoc.siplutions.net/

متصفح باسكالhttp://www.peganza.com/

doxygen.http://www.doxygen.nl/

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

Jadd - فقط Delphidoc آخرhttp://delphidoc.sourceforge.net/

مناقشة stackoverflow.

هل يوجد مستندات قانون دلفي يدعم بناء جملة دلفي الحالي؟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

توثيق دلفيhttps://stackoverflow.com/Questions/33336/documenting-delphi.

Answer 2

أحدث تحليل الدعم Delphis من وثائق XML. كما يستخدمون هذه المعلومات في تلميحات (على سبيل المثال إذا قمت بنقل مؤشر الماوس فوق اسم طريقة).

أنا أستخدم هذا القالب لتوثيق الأسلوب:

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

Answer 3

أنا أفضل مستندات خارج المصدر (يحصل دائما على فوضوي)، واستخدام FPDOC الممتاز الذي يأتي مع FPC. (يتم كتابة مستندات FPC الخاصة بها في ذلك).

Answer 4

في مشروع أنا أعمل حاليا، نحن نستخدم delphicodetetodoc., ، الذي يعمل بشكل جيد بشكل معقول. بناء الجملة يشبه هذا:

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

يبدو أن Doxygen لديه أداة والتي يمكن استخدامها جنبا إلى جنب وثيقة Pascal و دلفي رمز. وبعد ربما هذا يساعدك.

Answer 6

هناك عدة معايير، عادة اعتمادا على أداة الوثائق المستخدمة. نستخدم Pasdoc، لذلك نلتزم في الغالب بتنسيقها http://pasdoc.siplutions.net/ الذي يعتمد على جافادوك.

بدلا من ذلك، هناك XMLDOC كما أشار GABR، وهناك عدد قليل من الأدوات الأخرى، وجود بناء جملة مماثل مع وجود فروق خفية.