Комментарии к XML-документации (Руководство по программированию на C#)
В Visual C# можно создать документацию для кода, включив теги XML в специальные поля комментария в исходном коде непосредственно перед блоком кода, к которому они относятся.Примеры.
/// <summary>
/// This class performs an important function.
/// </summary>
public class MyClass{}
При выполнении компиляции с параметром /doc компилятор выполнит поиск всех тегов XML в исходном коде и создаст файл документации XML.Для создания конечной документации на основе созданного компилятором файла можно создать пользовательское средство или использовать такое средство, как Sandcastle.
.gif "Примечание") Примечание |
|---|
Комментарии XML-документации не являются метаданными. Они не включаются в скомпилированную сборку, и поэтому к ним нельзя обратиться посредством отражения. |
Содержание
Связанные разделы
Дополнительные сведения см. в следующих разделах.
Спецификация языка C#
Дополнительные сведения см в Спецификация языка C#. Спецификация языка является предписывающим источником информации о синтаксисе и использовании языка C#.