Я ищу хороший инструмент для создания файлов HTML / справки из моей XML-документации VS2010. Я нашел несколько коммерческих инструментов, например
Я уверен, что их больше, я просто привожу эти два в качестве примеров. Также существуют простые таблицы стилей XSLT для преобразования документации XML в HTML.
Что вы используете, например есть ли бесплатный инструмент для преобразования, возможно, в виде надстройки. Чтобы уточнить, в основном я нашел два типа инструментов:
- Те, которые конвертируют файл документации XML в разные целевые форматы, это то, что я ищу.
- Инструменты, помогающие мне создавать XML-документацию в исходном коде. Это не (!) То, что я ищу.
Спасибо за вашу помощь.
Комбинация Sandcastle / SHFB отлично работает. Спасибо всем, кто помог.
Некоторые замечания:
- NDoc кажется устаревшим, последние обновления датированы 2005 годом. Поэтому я пропустил это.
- Аналогичный поток, также очень подробный, можно найти здесь: https://stackoverflow.com/questions/3082044/how-to-turn-c-xml-doc-comments-into-something-useful Спасибо за подсказку!
- Есть несколько источников 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.
- Обновление от ноября 2012 года. Для небольших проектов я использую Doxygen - мне кажется, его немного проще настроить.