Ответ 1
В результате я использовал Sandcastle для создания простого HTML и использования этого. Неизбежно, я просто напишу свой собственный парсер или собственный шаблон для Sandcastle.
Мне не понравилась кривая обучения для Doxygen или QDoc.
Есть ли способ создать документацию wiki для github из моих комментариев документации XML на С#?
Я хочу создать документацию API для моего проекта с открытым исходным кодом в Github. Я хотел бы создать их автоматически из комментариев по документации XML в моих проектах С#. Мой слабый гуглинг появился в пузырьке. Есть ли способ сделать это?
Я бы предпочел, чтобы это было в стиле Github Markdown.
Ответы
Ответ 2
После поиска немного, я нашел этот камень сущности:
Создает Markdown из файла документации VS XML
Он выводит на консоль С# XML → markdown. Я уверен, что его можно улучшить, но это действительно отличное начало. Я протестировал его, и он полностью работает.
Ответ 3
Здесь онлайн-документ С# XML для конвертера Markdown: http://varus.io/vsdoc-2-md/
Он основан на алгоритме @formixian.
Ответ 4
Я бы порекомендовал Doxygen. Конфигурируя Doxygen, используя файлы cofigure и XSLT, вы можете в значительной степени что-либо с этим сделать. http://www.stack.nl/~dimitri/doxygen/
Установите исходные файлы и выведите их в файлы конфигурации, затем используйте XSLT для настройки вывода.
FOr Doxygen ther - инструмент анализатора (http://code.google.com/p/doxygenxmlparser/), уже подготовленный для выполнения большей части работы с С#
if (youDoNotLikeThisIdea == true) Другим инструментом, который может быть сконфигурирован, является QDoc (часть Qt API) @http://qt-project.org. Конечно, использование QDoc потребует от вас, в частности, Qt и QDoc.
Удачи!