C ++ comentarios XML para generar MSDN estilo CHM [cerrada]
-
21-08-2019 - |
Pregunta
Tengo varios proyectos, algunos utilizando código administrado y algunos usando solamente no administrado. Todos tienen se han añadido los comentarios XML y la documentación XML se está generando correctamente (el archivo XML generado y los archivos intermedios XDC).
Seguramente hay algo que puede tomar estos archivos (la salida del xdcmake) y generar MSDN ayuda CHM estilo! ? Por lo que entiendo, tanto doxygen y castillo de arena ignoran que paso obvio y reinventar la rueda para volver a escanear el código. (También está el hecho de que el castillo de arena es aparentemente inútil para proyectos non-.NET).
Tener doxygen tratado (salida horrible, pero rápido) y el castillo de arena (agradable estilo de salida de MSDN, pero sloooooow) ambos están pidiendo para ser superado por algo mucho más simple.
También sería agradable si había algún tipo de editor asociado que también podemos escribir la clase 'Introducción' y 'Información' de páginas que también se necesitan con cualquier documentación de la API.
¿Alguien sabe de alguna solución?
Solución
Es posible que desee probar DoxyComment . Aquí está la descripción de Doxygen de herramientas y scripts de ayuda :
Un complemento para Visual Studio 2005 llamada DoxyComment fue creado por Troels Gramo. Está diseñado para ayudarle a comentario sensibles inserción de contexto bloques en los archivos de código fuente C / C ++. DoxyComment también viene con un XSLT plantilla que le permite generar documentación como la biblioteca de MSDN.
Otros consejos
Sinceramente, Castillo de arena es su mejor apuesta. Sé que puede ser un poco de un dolor de configurar, pero la documentación es exactamente el estilo que buscas.
Sé que el proyecto donde la gente todavía utiliza NDocConsole
Sin embargo, supongo que NDoc es un proyecto muerto, porque en http://ndoc.sourceforge.net/ no hay actualizaciones desde 2005