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

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

  • Статья

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

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

Примечание

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

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

Теги

<c>

<para>

<see>*

<code>

<param>*

<seealso>*

<example>

<paramref>

<summary>

<exception>*

<permission>*

<typeparam>*

<include>*

<remarks>

<typeparamref>

<list>

<returns>

<value>

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

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

/// <summary cref="C &lt; T &gt;">

См. также

Ссылки

/doc (параметры компилятора C#)

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

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

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