Каковы теги документации C#? [закрытый]
В документации C# теги позволяют Вам производить вывод, подобный MSDN. Что такое список допустимых тегов для использования в///(тройная наклонная черта) область комментария выше классов, методов и свойств?
7 ответов
Выезд Замечательная документация относительно различных тегов документации XML C#. (Переходят к нижней части для наблюдения тегов)
Если Вы вводите это чуть выше метода, или класс, intellisense должен предложить Вам со списком доступных тегов:
/// <
Посмотрите в документах для Замок из песка . Это - новый стандарт документации для.NET.
См. превосходную статью MSDN здесь как Ваша первая остановка.
Вот список:
- сводный
- параметрический усилитель
- возвраты
- пример
- код
- видит
- список seealso
- значение
- , авторское право файла
Вот является примером:
<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>
Статья MSDN с 2002, детализируя все теги и когда использовать их:
GhostDoc помогает путем создания тупикового комментария для метода/класса.