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

Question

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

• Инструмент документации .Net
• ВСДокман

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

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

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

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

---

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

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

1. NDoc кажется устаревшим, последние обновления датированы 2005 годом.Вот почему я пропустил это.
2. Аналогичную тему, тоже очень подробную, можно найти здесь: https://stackoverflow.com/questions/3082044/how-to-turn-c-xml-doc-comments-into-something-useful Спасибо за подсказку!
3. Есть несколько исходников для Sandcastle, последняя версия, которую я нашел, находится здесь: http://sandcastle.codeplex.com/
4. Чтобы сгенерировать MsHelp2 Мне пришлось установить VS 2008 SDK, содержащий hscomp.exe.Есть версия 1.0 и 1.1, насколько я понял версия 1.0 содержит компилятор.Видеть Хеликссофт и Социальный MSDN для некоторых подробностей.
5. В моем случае созданная веб-справка не работает корректно с Chrome.Он всегда перезагружает страницу index.html.
6. А тема здесь показывает, как добавить информацию о пространстве имен в документацию по замку из песка.
7. Обновление от ноября 2012 г.:Для небольших проектов я использую Доксиген - Мне кажется, это немного проще настроить.

Answer 1

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

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

Answer 2

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

• Ndoc
• замок из песка

Answer 3

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