كيفية استخدام التعليقات المضمنة لتوثيق أعضاء في. NET؟

Question

وكيف يمكنني توثيق مضمنة عضوا في صافي؟ دعني أشرح. معظم الأدوات التي تستخرج وثائق من تعليقات تؤيد نوعا من وثائق مضمنة حيث يمكنك إضافة وجيزة بعد إعلان عضو. شيء من هذا القبيل:

public static string MyField; /// <summary>Information about MyField.</summary>

هل هناك طريقة للقيام بذلك في C # أو لغات. NET؟

Answer 1

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

Answer 2

وليس هناك وسيلة المدمج في القيام بذلك. نظام وثائق XML الهرمية. فإنه يعرف العلاقة بين العلامة <summary /> والبيانات التي تليها مباشرة.

Answer 3

نعم، مجرد وضعها قبل الشيء الذي أريد أن أعلق

/// <summary>Information about MyField.</summary>
public static string MyField;