هل هناك معيار (مثل phpdoc أو python's docstring) للتعليق على كود C#؟

Question

هل هناك اتفاقية قياسية (مثل phpdoc أو python's docstring) للتعليق على كود C# بحيث يمكن إنشاء وثائق الفصل تلقائيًا من الكود المصدري؟

Answer 1

يمكنك استخدام تعليقات نمط XML، واستخدام الأدوات لسحب تلك التعليقات إلى وثائق API.

فيما يلي مثال على أسلوب التعليق:

/// <summary>
/// Authenticates a user based on a username and password.
/// </summary>
/// <param name="username">The username.</param>
/// <param name="password">The password.</param>
/// <returns>
/// True, if authentication is successful, otherwise False.
/// </returns>
/// <remarks>
/// For use with local systems
/// </remarks>
public override bool Authenticate(string username, string password)

بعض العناصر لتسهيل ذلك هي:

GhostDoc, ، والتي توفر مفتاح اختصار واحدًا لإنشاء التعليقات تلقائيًا لفئة أو طريقة.قلعة الرمل, ، الذي يقوم بإنشاء وثائق نمط MSDN من تعليقات XML.

Answer 2

/// <summary>
///
/// </summary>
/// <param name="strFilePath"></param>

http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

Answer 3

تستخدم مايكروسوفت "تعليقات وثائق XML" والذي سيعطي أوصاف ذكاء IDE ويسمح لك أيضًا بإنشاء وثائق بنمط MSDN تلقائيًا باستخدام أداة مثل Sandcastle إذا قمت بتشغيل إنشاء مخرجات ملف XML.

لتشغيل إنشاء ملف XML للتوثيق، انقر بزر الماوس الأيمن على مشروع في الاستوديو المرئي، وانقر على "خصائص" وانتقل إلى علامة التبويب "إنشاء".في الأسفل، يمكنك تحديد موقع لملف إخراج تعليقات XML الخاص بك.

Answer 4

تشير الإجابات السابقة إلى بناء جملة XML بشكل مثالي.أردت فقط أن أطرح توصيتي بشأن مولد مكتبة مساعدة nDoc مجاني (ومفتوح المصدر). الذي يوزع كافة التعليقات في المشروع.

Answer 5

لقد تم دمج C# أوامر التوثيقاستمتع!

Answer 6

لقد طُلب مني دائمًا استخدام التعليقات الجماعية المفتوحة بعلامتين نجميتين أو أكثر لتحديد تعليقات التوثيق.

/**
Documentation goes here.
(flowerboxes optional) 
*/