1. Inicio
  2. Pregunta y respuesta
  3. Generador de documentación Visual studio C++

Generador de documentación Visual studio C++

2010-05-15 25 views

Respuesta

20

Puede usar el XML-Documentation, también compatible con VS2010. http://msdn.microsoft.com/en-us/library/ms177226%28VS.80%29.aspx

Después de comentar el código, puede utilizar castillo de arena para crear una documentación de MSDN-como: http://sandcastle.codeplex.com/. (Aquí es una representación gráfica de usuario para Castillo de arena, lo cual es mucho más fácil de usar: https://github.com/EWSoftware/SHFB)

utilizo AtomineerUtils para crear las cabeceras XML-Documentación automáticamente. Esta herramienta te ayudará mucho. Puede tener la versión de base gratuita aquí: http://www.atomineerutils.com/products.php

Fuente

2010-05-15 14:48:46 Simon

+3

1 - no sólo es que esto produce grandes documentos que buscan, el compilador anotará la salida con los tipos y tales los comentarios están unidos a y todo tipo de otras cosas. Si necesita conmutar por error a una plataforma cruzada, Doxygen también puede reconocer este formato. –

+2

Tengo problemas para calcular esto para un proyecto de C++, he encontrado esto: Proporcionar apoyo para el proyecto ++ (http://sandcastle.codeplex.com/workitem/3855) y la Muestra C/C++ C no administrado? (http://shfb.codeplex.com/discussions/217100/). Entonces, ¿es realmente posible usar Sandcastle para C++ nativo? –

+0

[GhostDoc] (http://submain.com/products/ghostdoc.aspx) y [CppTripleSlash] (https://visualstudiogallery.msdn.microsoft.com/22333333-fd6f-4dcb-8223-52701eddd7ad) son otras alternativas a crear las cabeceras en documento XML automáticamente – tcb

1

Una forma de generar documentación es, lo adivinó, javadoc. Simplemente tiene que hacer el comentario de la manera habitual, y javadoc hace un buen trabajo al convertirlos al estilo HTML/LaTeX.

Por supuesto, esa no es la única solución. Dejaré espacio para otros.

Fuente

2010-05-15 14:48:04

+1

Um .. Java y C++ son similares, pero no son tan similares. Javadoc no sabrá qué hacer cuando encuentre cosas como plantillas y tal en el código fuente. –

+0

@Billy: Sin embargo, puede usar comentarios de estilo Javadoc con Doxygen. –

13

Puede echar un vistazo a Doxygen.

Fuente

2010-05-15 15:07:53 KTC

+0

tengo que decir que no estoy impresionado por Doxygen. Incluso ahora (2017) no parece haber ninguna manera de generar la documentación parámetro que incluye automáticamente el tipo de parámetro, que tendría pensamiento sería un requisito bastante fundamental. – Neutrino

+0

Eso es para C++ por cierto. – Neutrino

3

Puede usar my addin, Atomineer Pro Documentation para generar rápidamente comentarios de documentación en formato Documentation-XML, Doxygen, Qt o JavaDoc. Luego use Sandcastle (DocXml) o Doxygen (DocXml, Doxygen, Qt, Javadoc) para convertir esta documentación en archivos de documentación externos.

Recomendaría el formato DocXml porque todas las herramientas anteriores funcionan con él, y Visual Studio lo reconoce (su sintaxis lo colorea, y crea los documentos en su base de datos intellisense para que aparezca en la ayuda de herramientas como usted escriba nombres de clase/método en su código).

Fuente

2010-05-15 16:01:33

Cuestiones relacionadas

 Cuestiones relacionadas