visual Generando documentación de C#Comentarios XML




summary c sharp (8)

Recientemente comencé un nuevo proyecto y estoy usando C # por primera vez. Descubrí que si bien Visual Studio es útil para crear los comentarios XML de C # para documentar sus clases y métodos, no hay mucho que pueda hacer para generar documentación de estilo MSDN o Javadoc.

Google me dice que Visual Studio 2003 incluyó una herramienta para generar dicha documentación, pero ya no está incluida en las versiones posteriores del IDE.

¿Cuáles son mis opciones si deseo utilizar mi marcado XML cuidadosamente diseñado (¡te lo aseguro!).


Uso este, solo porque Sandcastle no parecía estar listo cuando lo necesitaba: Codedoc

Editar - Utilicé Internet Explorer en ese trabajo, me di cuenta de que el sitio no funcionaba en Firefox :(


Me alegra que hayas encontrado la mejor alternativa: ¡Doxygen! Estoy usando Doxygen para C # .NET y genera diagramas de clase, diagramas de herencia, etc. Aquí hay una publicación informativa en el blog .


Gracias a la respuesta de @zappan que me ayudó, voy a simplificar para todos los que quieran crear .Net Documentation. Yo uso este documento como referencia:

En primer lugar, debe habilitar "generar un archivo de documentación XML para Visual Studio" (Visual Studio no crea este archivo de forma predeterminada):

Haga clic derecho en el proyecto y seleccione Properties que traen la ventana Propiedades. Seleccione la pestaña Build y finalmente habilite el XML documentation file . Asegúrese de que después de esta etapa desarrolle su proyecto.

En segundo lugar, descargue Sandcastle Help File Builder, que ayuda a crear documentos API fácilmente al proporcionar una GUI. Observe que contiene el archivo de instalación de Sandcastle, por lo que no es necesario descargar Sandcastle.

Ahora, crear una documentación es fácil:

1- Abra el Creador de archivos de ayuda de Sandcastle y cree un nuevo proyecto.

2- En Project Explorer haga clic derecho en Documentation Source y seleccione Add Documentation Source .

3- Navegue a la carpeta donde se encuentra el archivo de ensamblaje dll y el archivo de documentación XML (generalmente en la carpeta bin / debug). Seleccione el ensamblaje y el archivo xml y haga clic en el botón Open .

4- En el menú de Documentation seleccione Build Project .

Después de este paso, la ayuda está en su proyecto de carpeta raíz Sandcastle y en la carpeta Ayuda.


Puedo sugerir humildemente probar ImmDoc.NET , un proyecto simple que desarrollé hace algún tiempo y que publiqué recientemente en CodePlex. Es liviano, muy fácil de usar y es compatible con .NET 2.0.


Live Documenter es una herramienta de documentación de comentarios de .NET. Funciona para todas las versiones de .NET y parece ser compatible con todas las nuevas características.


No puedo creer que hayan pasado 11 horas y nadie ha mencionado a NDoc , que hace exactamente lo que estás buscando.


@Portman: NDoc está muerto y, aunque Sandcastle puede ser el próximo mejor (para estar muerto), Doxygen es tan simple de utilizar directamente como "fuera de la caja", también es muy configurable.

También tiene una GUI que ayuda con la configuración y las pruebas para que pueda ajustar el contenido de su corazón.


Gracias por las respuestas, pero Sandcastle parece un poco doloroso de configurar y usar, así que seguí buscando. Acabo de encontrar otra alternativa: Doxygen .

Doxygen genera documentación de estilo de javadoc, aunque parece que su principal objetivo es generar documentación a partir de marcas personalizadas en sus comentarios. Evidentemente, Doxygen también admite comentarios de C # XML, ¡aunque no puedo encontrar ninguna mención de ello en su sitio web!

De todos modos, lo recomiendo. Es fácil de usar, admite múltiples idiomas y también genera diagramas de clase para usted.





xml-comments