Что такое теги документации C#?
В документации C# теги позволяют создавать выходные данные, аналогичные MSDN. Каков список допустимых тегов для использования внутри /// (тройной косой черты) области комментариев над классами, методами и свойствами?
Ответы 7
Статья MSDN от 2002 года с подробным описанием всех тегов и случаев их использования:
Проверьте Отличная документация по различным тегам документации C# XML. (спуститесь вниз, чтобы увидеть теги)
Увы, срок действия домена истек, и это неработающая ссылка.
Что ж, воняет - в кеше Google он все еще есть, но как долго, кто знает?
Я предполагаю, что это похоже на JavaDocs, когда вы публикуете его на веб-странице. Более подробная ссылка здесь: msdn.microsoft.com/en-us/library/b2s063f7.aspx
См. Отличную статью MSDN здесь в качестве первой остановки.
Ссылка больше не работает. К вашему сведению.
Так что почти каждая ссылка на каждый ответ на этот закрытый вопрос более десяти лет назад.
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>
Для C# нет тега автора
Что делать, если у меня есть URL-адрес, на который мне нужно указать для получения дополнительной информации? Куда мне это поставить?
@KevinDriedger - предлагаю вам отредактировать список и удалить тег author. На мгновение я был рад увидеть это здесь, а затем я был разочарован, прочитав проголосованный комментарий Nap и проверив его сам с помощью ссылка предоставленаДэвид Мохундро
Ответ отражает ваш запрос @yair
@KevinDriedger да, спасибо! Теперь точнее. Я не хочу толкать его (и я бы сам отредактировал ваш ответ, если бы это не было слишком большим вмешательством), но если бы он содержал ссылка на страницу рекомендуемых тегов документов MSDN, а также упомянул здесь все теги, которые есть (например, permissions, который отсутствует здесь и в отличие от copyright, которого там нет) - ИМХО, это было бы огромным улучшением.
Загляните в документацию для замок из песка. Это новый стандарт документации для .NET.
Посмотрите документацию от microsoft: https://docs.microsoft.com/