Рекомендуемые теги для комментариев документации (Руководство по программированию на C#)Recommended Tags for Documentation Comments (C# Programming Guide)

Компилятор C# обрабатывает комментарии документации в коде и форматирует их в виде XML-файла, имя которого задается с помощью параметра командной строки /doc.The C# compiler processes documentation comments in your code and formats them as XML in a file whose name you specify in the /doc command-line option. Для создания окончательной документации на основе сгенерированного компилятором файла можно создать пользовательское средство или применить такие средства, как DocFX или Sandcastle.To create the final documentation based on the compiler-generated file, you can create a custom tool, or use a tool such as DocFX or Sandcastle.

Теги обрабатываются в конструкциях кода, таких как типы и члены типов.Tags are processed on code constructs such as types and type members.

Примечание

Комментарии документации не применяются к пространству имен.Documentation comments cannot be applied to a namespace.

Компилятор обрабатывает любые теги, имеющие допустимый формат XML.The compiler will process any tag that is valid XML. С помощью следующих тегов реализуются часто используемые в пользовательской документации возможности.The following tags provide generally used functionality in user documentation.

ТегиTags

<c><c> <para><para> <see>*<see>*
<code><code> <param>*<param>* <seealso>*<seealso>*
<example><example> <paramref><paramref> <summary><summary>
<exception>*<exception>* <permission>*<permission>* <typeparam>*<typeparam>*
<include>*<include>* <remarks><remarks> <typeparamref><typeparamref>
<list><list> <returns><returns> <value><value>

(* указывает, что компилятор проверяет синтаксис.)(* denotes that the compiler verifies syntax.)

Чтобы ввести в текст комментария документации угловые скобки, используйте символы < и >, как показано в следующем примере.If you want angle brackets to appear in the text of a documentation comment, use < and >, as shown in the following example.

/// <summary cref="C < T >">  
/// </summary>  

См. такжеSee also