Что такое теги документации C#?[закрыто]

Question

В документации C# теги позволяют создавать выходные данные, аналогичные MSDN.Каков список допустимых тегов для использования внутри области комментариев /// (тройной косой черты) над классами, методами и свойствами?

Answer 1

Проверить Отличная документация по различным тегам XML-документации C#. (Перейдите вниз, чтобы увидеть теги)

Answer 2

Если вы введете это прямо над методом или классом, intellisense предложит вам список доступных тегов:

/// <

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

ПризракДок помогает, создавая комментарий-заглушку для вашего метода/класса.

Answer 6

См. отличную статью MSDN. здесь в качестве вашей первой остановки.

Answer 7

Загляните в документацию, чтобы найти замок из песка.Это новый стандарт документации для .NET.