¿Visual Studio tiene una opción para generar documentación html para comentarios al estilo Javadoc?

¿Visual Studio tiene una opción para generar documentación html para comentarios estilo Javadoc? Si es así, ¿qué pasos son necesarios para lograr esto?¿Visual Studio tiene una opción para generar documentación html para comentarios al estilo Javadoc?

En BlueJ hay una opción para traducir comentarios de estilo Javadoc en un archivo html.

como la siguiente imagen muestra para Java usando BlueJ quiero hacer lo mismo con Visual Studio: http://www.time-tripper.com/uipatterns/Patterns/Titled_Sections/javadoc.gif http://www.time-tripper.com/uipatterns/Patterns/Titled_Sections/javadoc.gif

Fuente

2009-12-20 Brandon

se puede elaborar más de lo que usted está tratando de lograr? – Alon

para qué idioma? – Alon

@Alon Estoy usando C++ en Visual Studio. – Brandon

es lo que realmente quiere decir JavaDoc, en Java? Si es así, no lo creo, solo use javadoc. Visual Studio realmente no es compatible con Java.

Si se refiere a C# comentarios de la documentación XML, a continuación, puede cambiar las propiedades del proyecto para construir el archivo XML, y luego usar NDoc (descontinuado) o Sandcastle para construir HTML (o CHM etc). No es tan fácil como podría ser, sin duda.

EDITAR: Si está utilizando C++, probablemente debería mirar Doxygen. Puede haber complementos de Visual Studio, pero es mejor que solo ejecute Doxygen como parte de su proceso de compilación. Si usa C++/CLI, puede haber algún equivalente de comentarios XML de C#, pero no lo sé.

Fuente

2009-12-20 09:33:18

Con Sandcastle me pareció horrible de usar. Se necesitan, literalmente, siete pasos complejos para generar la documentación. Sin embargo, hay un proyecto (no puedo recordar el nombre ahora, Google lo sabrá) que construye SandCastle alrededor de una GUI y lo hace agradable y fácil de usar. También puede conectarlo en parte de su proceso de compilación – Finglas

Al subir la votación de su respuesta, eliminaré la mía. Yo malentendí la pregunta. :) – GrayWizardx

Quizás el generador de archivos de ayuda de Sandcastle: http://www.codeplex.com/SHFB ... parece ser una interfaz para Sandcastle. – ChrisW

Puede usar un estilo de comentarios compatible con Javadoc, ya sea al ingresar los comentarios a mano, o usar mi complemento, Atomineer Pro Documentation para sacar la mayor parte del trabajo. Luego, para generar documentación externa, use doxygen, que dice javadoc alegremente.

La alternativa es (como Jon ha dicho) utilizar los comentarios de formato XmlDoc, que pueden ser utilizados por Visual Studio (para información sobre herramientas intellisense), Atomineer, Sandcastle y Doxygen. Es un formato menos legible, pero te ofrece ventajas significativas dentro del entorno de Visual Studio, por lo que es un poco más flexible.

Ambos enfoques funcionan para C#, C++, C (C#, aunque funciona mejor en el lado de las cosas intelisense)

Fuente

2009-12-20 20:16:19

¿Visual Studio tiene una opción para generar documentación html para comentarios al estilo Javadoc?

Respuesta

Cuestiones relacionadas