ما هي علامات التوثيق C#؟[مغلق]

Question

تسمح لك علامات التوثيق في C# بإنتاج مخرجات مشابهة لـ MSDN.ما هي قائمة العلامات المسموح باستخدامها داخل منطقة التعليق /// ​​(الشرطة المائلة الثلاثية) فوق الفئات والأساليب والخصائص؟

Answer 1

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

Answer 2

إذا كتبت هذا فوق طريقة أو فئة مباشرةً، فمن المفترض أن يطالبك التحسس الذكي بقائمة من العلامات المتاحة:

/// <

Answer 3

وهنا قائمة:

• ملخص
• المعلمة
• عائدات
• مثال
• شفرة
• يرى
• أنظر أيضا
• قائمة
• قيمة
• ملف
• حقوق النشر

هنا مثال:

<file>
<copyright>(c) Extreme Designers Inc. 2008.</copyright>
<datecreated>2008-09-15</datecreated>
<summary>
Here's my summary
</summary>
<remarks>
<para>The <see cref="TextReader"/> can be used in the following ways:</para>
<list type="number">
<item>first item</item>
<item>second item</item>
</list>
</remarks>
<example>
<code>
System.Console.WriteLine("Hello, World");
</code>
</example>
<param name="aParam">My first param</param>
<returns>an object that represents a summary</returns>
</file>

Answer 4

مقالة MSDN من عام 2002 توضح بالتفصيل جميع العلامات ومتى يتم استخدامها:

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

Answer 5

GhostDoc يساعد عن طريق إنشاء تعليق كعب الروتين لطريقتك/فئتك.

Answer 6

راجع مقالة MSDN الممتازة هنا كمحطتك الأولى.

Answer 7

ابحث داخل المستندات عن قلعة الرمل.هذا هو معيار التوثيق الجديد لـ .NET.