Где создается документация C # с использованием комментариев XML (Visual Studio 2010)?

Question

Знаете ли вы, где создается эта документация?
Обычно ее можно создать с помощью:

/// <summary>
/// I just want to test something
/// </summary>
/// <param name="args"></param>

Знаете ли вы, где опции в VS изменяют ее?

Answer 1

Настройка по умолчанию для проектов C # не создает документацию, но ее легко исправить.Просто:

1) Щелкните правой кнопкой мыши на проекте, который нуждается в документации, и выберите свойства.
2) Нажмите на вкладку сборки слева.
3) Установите флажок в документации и выберите путь, если необходимо.
4) Получайте прибыль и наслаждайтесь.

Инструкции для VS 2010 premium, YMMV.

Answer 2

Создание файла документации XML из Visual Studio - это только начало процесса.Полный процесс выглядит следующим образом:

• Добавление XML-комментариев к вашему проекту
• Пусть Visual Studio сгенерирует файл XML-документа
  • Свойства проекта
  • Закладка Build
  • XML-файл документации
• Используйте инструмент создания документации для преобразования XML-файла в файл справки (chm), веб-сайт (html, aspx) илидругие форматы.Вот некоторые инструменты для этого:
  • SandCastle
  • NDoc

Дополнительная информацияможно найти в этом вопросе StackOverflow .