Бесплатный инструмент для разработки XML-документации Visual Studio

Я ищу бесплатный инструмент для создания XML-документации в Visual Studio 2010.

Я знаю документ! Х

но я ищу бесплатный или аналогичный инструмент с открытым исходным кодом.

Есть идеи ?

Спасибо.


person Yoann. B    schedule 29.09.2010    source источник


Ответы (3)


Вам следует попробовать SandCastle с Конструктор файлов справки SandCastle

Sandcastle, созданный Microsoft, представляет собой инструмент, используемый для создания документации в стиле MSDN из сборок .NET и связанных с ними XML-файлов комментариев. Текущая версия — май 2008 года. Он основан на командной строке и не имеет графического интерфейса пользователя, функций управления проектами или автоматизированного процесса сборки, подобных тем, которые вы можете найти в NDoc. Конструктор файлов справки Sandcastle был создан, чтобы заполнить пробелы, предоставить отсутствующие функции, подобные NDoc, которые используются чаще всего, а также предоставить графические инструменты и инструменты на основе командной строки для автоматического создания файла справки.

(Айенде написал сообщение в блоге о создании документации API )

person Julien Hoarau    schedule 29.09.2010
comment
Я не ищу инструмент генерации (в настоящее время я использую Sandcastle с SHFB). Я ищу графический (Plugin/VS Extension?) инструмент для разработки, чтобы редактировать комментарии в исходном коде ref/examples и т. д. - person Yoann. B; 29.09.2010
comment
GhostDoc может опционально добавлять TODO к сгенерированным комментариям, поэтому можно использовать панель «Задачи» для удобной навигации и редактирования каждого из них. Я думаю, что это доступно только в версии Pro, но лучше проверить их таблицы сравнения продуктов. - person George Birbilis; 16.12.2015

хотя я не использовал его лично, я слышал хорошие отзывы о doxygen - http://www.doxygen.nl/

person czuroski    schedule 29.09.2010

Я не знаю о каких-либо бесплатных инструментах документирования "wysiwyg", таких как DocumentX.

Однако для ввода и обновления комментариев к документации (для использования SandCastle или Doxygen) вы можете найти мою надстройку, AtomineerUtils Pro Documentation удобно. (Это не бесплатно, но очень недорого и значительно сокращает время/работу, затрачиваемую на документирование исходного кода)

person Jason Williams    schedule 21.03.2012