Практическое руководство. Создание документации проекта в формате XML

Обновлен: Ноябрь 2007

Свойство Создать XML-файл документации определяет, будет ли создан XML-файл во время компиляции. Значение данного свойства задается на странице Компиляция(для Visual Basic) или Построение (для Visual C#) в окне Конструктор проектов. Если этот параметр выбран, XML-документация автоматически генерируется в XML-файл, который будет иметь то же имя что и проект, но с расширением XML.

Дополнительные сведения о XML-документации в проектах Visual Basic содержатся в разделе Практическое руководство. Создание XML-документации в Visual Basic. Для Visual C# см. Комментарии XML-документации (Руководство по программированию в C#).

Совет.
В большинстве случаев нет необходимости создавать документацию в формате XML каждый раз при компиляции проекта; возможно, ее потребуется создать после того, как разработка приложения завершена. Для больших проектов отключение этого параметра может ускорить компиляцию.

Для создания XML-файла документации для проекта Visual Basic

1. Выбрав проект в Обозревателе решения, в меню Проект выберите команду Свойства.

2. Перейдите на вкладку Компиляция.

3. На странице Компиляция, выберите Создать XML-файл документации. По умолчанию файл создается в указанной выходной директории, например, "bin\Debug\Projectname.XML".

Для создания XML-файла документации для проекта Visual C#

1. Выбрав проект в Обозревателе решения, в меню Проект выберите команду Свойства.

2. Перейдите на вкладку Построение.

3. На странице Построение, выберите XML-файл документации. По умолчанию файл создается в указанной выходной директории, например, "bin\Debug\Projectname.XML".

См. также

Задачи

Практическое руководство. Создание XML-документации в Visual Basic

Ссылки

Комментарии XML-документации (Руководство по программированию в C#)

Страница “Дополнительно, папка “C#”, папка “Текстовый редактор”, диалоговое окно “Параметры”

Другие ресурсы

Управление свойствами компиляции