-doc
Обрабатывает комментарии к документации в XML-файл.
Синтаксис
-doc[+ | -]
or
-doc:file
Аргументы
| Термин | Определение |
|---|---|
+ | - |
Необязательно. Если задать + или -doc, компилятор создаст документацию и поместит ее в XML-файл. Если задать -, что эквивалентно отсутствию -doc, компилятор не будет создавать документацию. |
file |
Является обязательным, если используется параметр -doc:. Определяет выходной XML-файл, который заполняется комментариями из файлов исходного кода, участвующих в компиляции. Если имя файла содержит пробел, заключите его в кавычки (" "). |
Замечания
Параметр -doc определяет, будет ли компилятор создавать XML-файл, содержащий комментарии. Если вы используете синтаксис -doc:file, параметр file определяет имя XML-файла. Если вы используете -doc или -doc+, компилятор использует имя XML-файла из исполняемого файла или библиотеки, создаваемой компилятором. Если вы используете -doc- или не задаете параметр -doc, компилятор не создает XML-файл.
В файлах исходного кода комментарии к документации могут предшествовать таким определениям:
определяемые пользователем типы, такие как class или interface;
члены, такие как field, event, property, function или subroutine.
Чтобы использовать созданный XML-файл с помощью такой функции Visual Studio, как IntelliSense, имя XML-файла должно совпадать с именем сборки. Убедитесь, что XML-файл находится в том же каталоге, что и сборка, чтобы при обращении к сборке в проекте Visual Studio XML-файл мог бы также быть найден. XML-файлы документации не являются обязательными для работы IntelliSense с кодом в рамках одного или нескольких проектов, на которые ссылается проект.
XML-файл содержит теги <assembly></assembly>, если сборка не выполняется с помощью -target:module. Эти теги указывают имя файла, содержащего манифест сборки для выходного файла компиляции.
Способы создания документации из комментариев в коде описаны в разделе об XML-тегах комментариев.
| Настройка параметра -doc в интегрированной среде разработки Visual Studio |
|---|
| 1. Выбор проекта в Обозреватель решений. В меню Проект выберите пункт Свойства. 2. Щелкните вкладку "Компиляция ". 3. Задайте значение в поле "Создание XML-документации". |
Пример
Пример см. в статье Документирование кода с помощью XML-комментариев.
