Создание файлов HTML/справки из документации VS 2010 С# XML

Я ищу хороший инструмент для создания файлов HTML/справки из моей документации XML VS2010. Я нашел некоторые коммерческие инструменты, такие как

Я уверен, что есть больше, я просто перечислю эти два примера. Также есть простые таблицы стилей XSLT для преобразования документации XML в HTML.

Что вы используете, например? есть бесплатный инструмент для преобразования, возможно, как надстройка. Чтобы уточнить, в основном я нашел два типа инструментов:

  • Те, кто преобразует файл документации XML в разные целевые форматы, это то, что я ищу.
  • Инструменты, помогающие мне генерировать XML-документацию в исходном коде. Это не (!) То, что я ищу.

Спасибо за вашу помощь.

Комбинация Sandcastle/SHFB отлично работает. Спасибо всем, кто помог.

Некоторые замечания:

  • NDoc кажется устаревшим, последние обновления с 2005 года. Вот почему я пропустил это.
  • Аналогичную тему, также очень подробную, можно найти здесь: Как превратить С# Xml Doc-Комментарии во что-то полезное? Спасибо за подсказку!
  • Есть несколько источников для Sandcastle, последняя найденная нами версия находится здесь: http://sandcastle.codeplex.com/
  • Чтобы сгенерировать MsHelp2, мне пришлось установить VS 2008 SDK, содержащий hscomp.exe. Существует версия 1.0 и 1.1, насколько я могу понять, что версия 1.0 содержит компилятор. Подробнее см. Helixsoft и Social MSDN.
  • В моем случае сгенерированный WebHelp не работает корректно с Chrome. Он всегда перезагружает страницу index.html.
  • тема здесь показывает, как добавить информацию о пространстве имен в документацию sandcastle.
  • Обновление от Nov 2012: для небольших проектов я использую Doxygen - мне немного легче настроить.

Ответы

Ответ 1

Мы используем Sandcastle для преобразования и Sandcaple Help File Builder в качестве пользовательского интерфейса для управления проектами справки. По моему мнению, красота Sandcastle и SHFB заключается в том, что помимо "средней" документации исходного кода вы можете добавить дополнительную информацию, такую ​​как архитектура программы, шаблоны, которые должны соблюдаться, или любой дополнительный концептуальный контент для вашего проекта, который не связан прямо к одному классу в вашей программе. Это можно сделать, создав дополнительные файлы xml с помощью Microsoft Authoring Schema (можно отредактировать визуальную студию в виде XML файла, а схема для нее доступна). Его довольно легко начать с этих инструментов для создания MSDN, как документация.

Давным-давно я пробовал docbook, который практически совпадает с технической стороной (xml файлы, содержащие информацию и файлы xslt, чтобы преобразовать его в различные типы вывода). Но для нас это не было возможным, потому что нет никакого преобразования, которое могло бы использовать визуальную студию, сгенерированную XML-документацию (плюс трансформация концептуального контента была довольно болезненной для нас).

Ответ 2

Еще два бесплатных инструментария, которые позволяют создавать документацию из комментариев Xml:

Ответ 3

Sandcastle + SHFB - отличная комбинация. Бесплатно и генерирует html, chm и т.д.