Генерация HTML / файлов справки из документации VS 2010 C # XML - PullRequest
26 голосов
/ 24 января 2011

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

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

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

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

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


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

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

  1. NDoc, кажется, устарел, последние обновления 2005 года. Вот почему я пропустил это.
  2. Aпохожая тема, также очень подробная, можно найти здесь: 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 содержит компилятор.Подробнее см. Helixsoft и Социальный MSDN .
  5. В моем случае сгенерированный WebHelp не работает правильно с Chrome.Он всегда перезагружает страницу index.html.
  6. В теме здесь показано, как добавить информацию о пространстве имен в документацию sandcastle.
  7. Обновление по состоянию на ноябрь 2012 года: для небольших проектов IЯ использую Doxygen - мне кажется, его немного проще настроить.

Ответы [ 3 ]

19 голосов
/ 24 января 2011

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

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

3 голосов
/ 24 января 2011

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

3 голосов
/ 24 января 2011

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

...