Пример XML-документации

Статья
11/05/2008

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

В этом примере показано использование XML для документирования кода. Дополнительные сведения см. в разделе Комментарии XML-документации (Руководство по программированию в C#).

Получение примеров и инструкций по их установке

Выполните одно или несколько из следующих действий:
- В меню Справка выберите пункт Примеры.
  
  Отобразится информация о примерах, содержащаяся в файле сведений о продукте.
- Посетите веб-узел примеров Visual Studio 2008 Здесь содержатся самые последние версии примеров.
- Найдите примеры на компьютере, где установлена среда Visual Studio. По умолчанию примеры и файл сведений о продукте устанавливаются в папку диск:\Program Files\Microsoft Visual Studio 9.0\Samples\lcid. Для выпусков Express продукта Visual Studio все примеры располагаются в Интернете.

Дополнительные сведения см. в разделе Поиск файлов примеров.

Примечание о безопасности.
Этот пример кода иллюстрирует концепцию и содержит только код, относящийся к этой концепции. Он может не отвечать требованиям безопасности для конкретных условий, и его не следует использовать в точности в том виде, в каком он приведен. Чтобы проект был безопасным и надежным, рекомендуется добавить код обеспечения безопасности и код обработки ошибок. Корпорация Майкрософт предоставляет этот пример кода на условиях “как есть”, без каких-либо гарантий.

Этот пример кода иллюстрирует концепцию и содержит только код, относящийся к этой концепции. Он может не отвечать требованиям безопасности для конкретных условий, и его не следует использовать в точности в том виде, в каком он приведен. Чтобы проект был безопасным и надежным, рекомендуется добавить код обеспечения безопасности и код обработки ошибок. Корпорация Майкрософт предоставляет этот пример кода на условиях “как есть”, без каких-либо гарантий.

Построение и использование примера XML-документации в среде Visual Studio

В обозревателе решений щелкните правой кнопкой мыши проект и выберите пункт Свойства.
Откройте папку "Свойства конфигурации" а затем щелкните Построить.
Задайте свойству "Файл XML-документации" значение "XMLsample.xml".
В меню Построение выберите команду Построить.

Выходной файл XML будет находиться в каталоге отладки.

Построение примера XML-документации из командной строки

Для создания примера XML-документации введите в командной строке следующее.
```
csc XMLsample.cs /doc:XMLsample.xml
```
Для просмотра созданного XML-кода, введите следующую команду.
```
type XMLsample.xml
```

См. также

Задачи

Практическое руководство. Использование XML-документации (Руководство по программированию в C#)

Основные понятия

Примеры по Visual C#

Руководство по программированию в C#

Поделиться через