Поделиться через

Рекомендуемые теги для комментариев документации (Руководство по программированию в C#)

  • Статья

Обновлен: Ноябрь 2007

Компилятор C# может обрабатывать комментарии документации в коде в XML-файл. Обработка XML-файла для создания документации является деталью, которая должна быть учтена при реализации в узле.

Теги обрабатываются в конструкциях кода, таких как типы и члены типов.

5ast78ax.alert_note(ru-ru,VS.90).gifПримечание.

Комментарии документации не могут быть применены к пространству имен.

Компилятор обрабатывает любой тег, который является допустимым тегом XML. Следующие теги предоставляют часто используемые возможности в пользовательской документации.

Теги

<c>

<para>

<see>*

<code>

<param>*

<seealso>*

<example>

<paramref>

<summary>

<exception>*

<permission>*

<typeparam>*

<include>*

<remarks>

<typeparamref>

<list>

<returns>

<value>

(* обозначает проверку синтаксиса компилятором.)

Чтобы вставить угловые скобки в текст комментария документации, используйте &lt; и &gt;. Например, &lt;текст в угловых скобках&gt;.

См. также

Задачи

Пример XML-документации

Основные понятия

Руководство по программированию в C#

Ссылки

/doc (комментарии документации процесса) (параметры компилятора C#)

Комментарии XML-документации (Руководство по программированию в C#)