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

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

Инструмент документации .NetVSdocman

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

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

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

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

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

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

NDoc, кажется, устарел, последние обновления 2005 года. Вот почему я пропустил это.Подобную тему, также очень подробную, можно найти здесь:Как превратить C # Xml Doc-Comments во что-то полезное? Спасибо за подсказку!Есть несколько источников для Sandcastle, последняя найденная версия находится здесь:http://sandcastle.codeplex.com/Для того, чтобы генерироватьMsHelp2 Я должен был установить VS 2008 SDK, содержащийhscomp.exe, Есть версии 1.0 и 1.1, насколько я мог понять, версия 1.0 содержит компилятор. ВидетьHelixsoft а такжеСоциальный MSDN для некоторых деталей.В моем случае сгенерированный WebHelp не работает правильно с Chrome. Он всегда перезагружает страницу index.html.тема здесь показывает, как добавить информацию о пространстве имен в документацию sandcastle.Обновление от ноября 2012: для небольших проектов я используюDoxygen - Мне немного проще настроить.
 Horst Walter24 янв. 2011 г., 18:00
Да, я не видел этого по некоторым причинам. Я обновлю это, как только я проверил некоторые из инструментов.
 jgauffin24 янв. 2011 г., 13:25
 kzu11 июн. 2013 г., 22:21
Могу ли я добавить NuDoc в список доступных API для чтения XML-документации?kzu.to/nudoc

Ответы на вопрос(3)

Решение Вопроса

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

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

 Horst Walter25 янв. 2011 г., 14:34
Sandcastle / SHFB прекрасно работает. Некоторые замечания ниже.

которые позволяют создавать документацию из комментариев XML:

NDocзамок из песка
 kzu11 июн. 2013 г., 22:28
Есть также простой простой API для чтения членов документации и создания чего-либо самостоятельно, просто реализуя простого посетителя: NuDockzu.to/nudoc
 codeulike01 мар. 2011 г., 15:55
Afaik, NDoc не очень хорошо поддерживает .NET 2 или более позднюю версию. например документация по дженерикам и т. д.

CHM и т. Д.

Ваш ответ на вопрос