В тегах документации C# вы можете производить вывод, похожий на MSDN. Каков список допустимых тегов для использования в области комментариев /// (тройная косая черта) над классами, методами и свойствами?Каковы теги документации C#?
Заканчивать Great documentation on the various C# XML documentation tags. (Перейти вниз, чтобы увидеть метки)
MSDN статья с 2002 года с подробным описанием всех тегов и когда использовать их:
Смотрите прекрасную статью MSDN here как ваша первая остановка.
GhostDoc помогает создать комментарий для вашего метода/класса.
Если вы напечатаете это чуть выше методы или класса, IntelliSense должен подсказать вам список доступных тегов:
/// <
Вот список:
Вот пример:
<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>
Просмотр Документов для Sandcastle. Это новый стандарт документации для .NET.
Увы, домен пропустил, и это неработающая ссылка. – 2010-03-19 00:41:14
Хорошо, что воняет - в кеше Google все еще есть, но как долго, кто знает? – 2010-03-19 02:11:15
Я предполагаю, что это так же, как JavaDocs, когда вы публикуете это на веб-странице. Более обновленная ссылка здесь: http://msdn.microsoft.com/en-us/library/b2s063f7.aspx – puretppc 2014-01-27 02:21:21