وثائق رمز لدلفي مشابهة لجافادوك أو ج # أكس ثيقة

Question

وأنا في حاجة الى أداة توثيق شفرة مماثلة لجافادوك أو ج # ثيقة أكس لرمز دلفي. ما هو أفضل وسيلة؟ أنا أفضل التكنولوجيا، والذي هو في المستقبل متوافق مع المشروع القلعة الرملية مايكروسوفت.

Answer 1

ونلقي نظرة على SynProject أو أداة مفتوحة المصدر مكتوب في دلفي.

وقد تم تصميمه للتعامل مع سير العمل وثائق كاملة من المواصفات لاطلاق سراح الملاحظات، بما في ذلك الاختبارات والهندسة المعمارية والتصميم؛ وبالطبع هناك محلل دلفي متكامل لإنتاج وثائق الهندسة المعمارية من شفرة المصدر دلفي القائمة.

لوثيقة الهندسة المعمارية، ويمكن شفرة المصدر استخراج تعليقات (علاء PasDoc) ثم تضمين هذا النص في وثيقة العمارة الرئيسية (مع مخططات الطبقة التسلسل الهرمي والتبعيات وحدة).

وتكتب ملف نص عادي باستخدام بناء جملة مثل ويكي في محرر نص مخصص، ثم SynProject يخلق منسقة بشكل جيد وثائق وورد منه. تتوفر للوصول إلى محتوى بعض المعالجات. لكن نظرا لأنه يتم تخزينها كملف عادي، المبرمجين متعددة يمكن أن يكتب عليه، وذلك باستخدام أي أداة SCM (SVN، الأحفوري ...).

وعلى سبيل المثال، وأنا حاليا استخدامه لكتابة وثائق الصيانة لتطبيق ضخمة والقدامى دلفي (حوالي 2،000،000 خطوط قانون مكتوب في دلفي 5 و 6)، مع عدم وجود الوثائق المتاحة السابقة. يمكنك أن تصف التغييرات التي أدخلت على قانون (بالاقتباس وحدة / فئة / طريقة)، ثم سوف أداة تحديث كافة الوثائق للتفكير وتتبع تلك التعديلات. وقد تم تصميم SynProject لتكون متوافقة مع بعض جدا "دقيقة" قواعد تنظيم (IEC 62304)، ولكن يمكن استخدامها لأي مشروع نظرا لتصميمها الفريد "مسطح".

ملاحظة : أنا نشر هذه فترة طويلة بعد السؤال، لأن SynProject لم يكن موجود في هذا الوقت، ويمكن أن يكون من المفيد النظر في. تم تعريف هذا الموضوع كمرجع لهذا السؤال .

Answer 2

ودلفي + جافادوك = DelphiCodeToDoc

Answer 3

وبقدر ما أنا على علم، ليس هناك أداة متوافقة بسهولة مع مايكروسوفت القلعة الرملية - على الأقل حتى شخص ما يزعج فعلا لكتابة واحدة، لتعديل واحدة موجودة، أو لإنشاء toolchain لتحويل الانتاج بشكل صحيح

ولقد استعملت شخصيا PasDoc مع نجاحا كبيرا. أوصي بناء أحدث نسخة SVN، منذ الإصدار الحالي ينعق في بعض الأحيان على تعريفات واجهة معقدة.

Answer 4

وجرب: - Doxygen الوثائق - Pas2Dox

Answer 5

ومنذ دلفي 2005 هو بناء في مترجم دلفي. ويستخدم معيار XMLDoc الذي يستخدم أسلوب تعليقات XML. تماما كما يفعل C #، لذا أعتقد القلعة الرملية قادرة على التعامل معها. انظر http://dn.codegear.com/article/32770 و <لأ href = " http://tondrej.blogspot.com/2006/03/xml-documentation-in-delphi-2006.html "يختلط =" noreferrer نوفولو "> http://tondrej.blogspot.com/2006/03/xml-documentation -في-دلفي-2006.html

وانظر أيضا توثيق دلفي

Answer 6

والقلعة الرملية يحتاج للوصول إلى المجالس من أجل توليد انها وثائق، وهو ما يعني أنه لا ينطبق إلا للغات دوت (على الرغم من أنني لست متأكدا قادرة Delphi.Net). ومع ذلك، دلفي 2007 و 2009 لديه وثائق XML مضمنة مشابهة جدا لC #. عند تشغيل خيار "توليد التوثيق XML" في خيارات المشروع، فإنه سيتم بناء ثائق XML استنادا إلى هذه التعليقات. ويمكن بعد ذلك XSLT استخدامها لتوليد أيا كان شكل الوثائق التي تحتاجها (وهذا هو الصعب بعض الشيء).

Answer 7

DelphiCodeToDoc دينا أيضا سطر الأوامر لاستخدامه مع أداة التكامل المستمر (على سبيل المثال).

Answer 8

والسؤال هو قديمة جدا، ولكن كان لي نفس المشكلة اليوم وجدت هذا المنصب. دلفي 2007 يسمح الجملة التالي، والتي يبدو أن يساوي C # الوثائق:

/// <summary>
/// Summary of the function / class
/// </summary>
/// <param name="param1">Description of the parameter param1</param>
/// <param name="param2">Description of the parameter param2</param>
/// <param name="param3">Description of the parameter param3</param>
/// <returns>Description of the return value</returns>
function test(param1, param2, param3: string): string;

ل<summary>، هناك لا يبدو أن هناك إمكانية للسماح بفواصل. <br /> لا يعمل.