visual-studio-2010 - practices - visual studio generate documentation from comments

¿Hay alguna manera de generar un wiki de documentación para github a partir de los comentarios de mi documentación XML en C#?

Question

Quiero generar documentación API para mi proyecto de código abierto en Github. Me gustaría crearlos automáticamente a partir de mis comentarios de documentación XML en mis proyectos de C #. Mi débil google ha aparecido Bubkiss. ¿Hay alguna forma de hacer esto?

Prefiero que sea en Markdown estilo Github.

Answer 1

Aquí hay un convertidor en línea de C # XML a Markdown: http://varus.io/vsdoc-2-md/

Se basa en el algoritmo de @formixian.

Answer 2

Después de buscar un poco alrededor, encontré esta joya de la esencia:

Genera Markdown desde el archivo de documentación de VS XML

Se imprime en C # XML -> markdown en la consola. Estoy seguro de que puede ser refinado aún más, pero este es un gran comienzo. Lo he probado, y está funcionando totalmente.

Answer 3

Terminé usando Sandcastle para generar HTML plano y usar eso. Inevitablemente, solo escribiré mi propio analizador o una plantilla personalizada para Sandcastle.

No me gustó la curva de aprendizaje para Doxygen o QDoc.

Answer 4

Yo recomendaría Doxygen. Al configurar Doxygen utilizando los archivos cofigure y XSLT puedes hacer casi cualquier cosa con él. http://www.stack.nl/~dimitri/doxygen/

Establezca los archivos de origen y la salida en los archivos de configuración, luego use XSLT para personalizar la salida.

FOr Doxygen ther es una herramienta de análisis (http://code.google.com/p/doxygenxmlparser/) ya preparada para realizar gran parte del trabajo con C #

if (youDoNotLikeThisIdea == true) Otra herramienta altamente configurable sería QDoc (parte de la API de Qt) @ http://qt-project.org . Por supuesto, usar QDoc requeriría que construyas Qt y QDoc en particular.

¡Buena suerte!