Документация XML (Visual C++)
В Visual C#, C++, можно добавлять комментарии в исходный код, который будет отображен в файл XML.Этот файл затем может быть входным в процесс, который создает документации для классов в коде.
В файле кода Visual C#, C++, комментарии XML-документации должны располагаться непосредственно перед метода или определения типа.Комментарии могут использоваться для заполнения подсказка данных кратких сведений Intellisense в следующих сценариях:
когда код компилироваться как компонент среды выполнения Windows с соответствующей файлом .winmd
если исходный код включен в текущем проекте
в библиотеке реализации которой объявления типов и находятся в том же файле заголовка
.gif "Примечание") Примечание |
|---|
В текущем выпуске, не обрабатываются комментарии к коду для шаблонов или другой тип, содержащий шаблона (например, при этом параметр в качестве шаблона).Добавление те комментарии не приведет к определенным расширения функциональности. |
Дополнительные сведения о создании файла XML с комментариями документации см. в следующих разделах.
Сведения о |
См. |
|---|---|
Использовать параметры компилятора |
|
Теги можно использовать для предоставления часто используемые функциональные возможности в документации |
|
Идентификатор, компилятор создает для определения конструкции в коде |
|
Как выделите тегов документации |
|
Создание файла XML из одного или нескольких файлов .xdc. |
|
Ссылки на сведения о XML, как оно относится к областям функций Visual Studio |
Если необходимо поместить, специальные символы XML в тексте документации комментируют необходимо использовать XML-сущности или раздел CDATA.