В тегах документации С# вы можете создавать выходные данные, подобные MSDN. Каков список допустимых тегов для использования в области комментариев///(тройная косая черта) над классами, методами и свойствами?
Каковы теги документации С#?
Ответ 1
Отъезд Отличная документация по различным тегам документации XML С#. (Идите в нижнюю часть, чтобы увидеть теги)
Ответ 2
Если вы наберете это чуть выше метода или класса, intellisense предложит вам список доступных тегов:
/// <
Ответ 3
Вот список:
- summary
- param
- возвращает
- пример
- код
- см
- seealso
- список
- значение
- Автор
- файл
- авторские права
Вот пример:
<file> <copyright>(c) Extreme Designers Inc. 2008.</copyright> <author>Kevin Driedger</author> <datecreated>2008-09-15</datecreated> <summary> Here 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>
Ответ 4
Статья MSDN от 2002 года, в которой подробно описаны все теги и когда их использовать:
Ответ 5
GhostDoc помогает, создав комментарий заглушки для вашего метода/класса.
Ответ 6
В качестве первой остановки просмотрите отличную статью MSDN здесь.
Ответ 7
Просмотрите документы для Sandcastle. Это новый стандарт документации для .NET.