logo
CSharp_Prog_Guide

Комментарии xml-документации

В Visual C# можно создать документацию для кода, включив теги XML в специальные поля комментария в исходном коде непосредственно перед блоком кода, к которому они относятся. Пример.

/// <summary>

/// This class performs an important function.

/// </summary>

public class MyClass{}

При выполнении компиляции с параметром /doc компилятор выполнит поиск всех тегов XML в исходном коде и создаст файл документации XML.

Примечание.

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