Cómo formatear la documentación de Visual Studio XML para visualizarla en la web

Estoy usando Visual Studio 2010 y he comenzado a ser un buen chico y a documentar todo mi código mientras lo escribo, a través de comentarios XML. Tengo un proyecto bien documentado e incluso descubrí cómo hacer que Visual Studio escupe un documento XML completo al hacer una compilación. Mi pregunta es, ¿cuál es la mejor forma de formatear/mostrar este documento en la web para que aparezca en un formato amigable y útil como MSDN? ¿Hay alguna herramienta que haga esto fácilmente?Cómo formatear la documentación de Visual Studio XML para visualizarla en la web

¡Gracias de antemano!

Fuente

2011-03-04 Chev

posible duplicado de [¿Tiene Visual Studio tiene una opción para generar documentación HTML para comentarios Javadoc de estilo?] (Http://stackoverflow.com/questions/1935351/does-visual-studio-have-an-option -to-generate-html-documentation-for-javadoc-sty) – Alfabravo

Echa un vistazo Sandcastle Help File Builder. Esta es una herramienta de GUI que hace que Sandcastle sea bastante fácil de usar. Se instalará en una carpeta en el menú Inicio-> Archivos de programa-> Sandcastle Help File Builder .; Es bastante fácil de usar, pero no es increíblemente rápido.

Espero que ayude!

Fuente

2011-03-04 21:44:35 pmartin

Logré obtener esto para crear documentación durante el evento de compilación de Visual Studio. Mira mi respuesta a esta pregunta: http://stackoverflow.com/questions/211693/generate-html-documentation-automatically-during-a-build-with-sandcastle/5200822#5200822 – Chev

El repositorio se ha movido de Codeplex a [ GitHub] (https://github.com/EWSoftware/SHFB) – Jessycormier

Consulte Sandcastle.

Sandcastle produce documentación precisa, de estilo MSDN, completa reflejando los ensamblados de origen e integrando XML XML Documentation Comments.

Wikipedia tiene más información y enlaces a proyectos adicionales que se integran con castillos de arena.

Otra opción (que parece ser mucho más fácil de usar) es docu:

Un generador de documentación para .Net que no es complicado, incómodo o difícil de usar. Dado un ensamblado y el XML generado por Visual Studio, docu puede producir todo un sitio web de documentación con un solo comando.

Una tercera opción es NDoc:

NDoc genera documentación de la biblioteca de clases de NET y los archivos de documentación XML generados por el compilador de C# (o con una herramienta adicional para VB .RED).

NDoc utiliza documentadores conectables para generar documentación en varios formatos diferentes, incluido el formato de Ayuda HTML de estilo de MSDN (.chm), el formato de Ayuda Visual Studio .NET (Ayuda HTML 2) y las páginas web de estilo MSDN-online.

Fuente

2011-03-04 20:41:04 Oded

Es gracioso, ese es el primero que encontré. Parecía bastante engorroso. No creo que se lea desde el documento XML generado, sino que se lee desde los archivos .cs mismos. Esta es una opción segura, pero me gustaría ver si alguien más tiene otras opciones para presentar. – Chev

@Chevex - ha sido el rey durante años ... He actualizado mi respuesta con otra opción. – Oded

Quiero usar castillos de arena pero me está confundiendo bastante. Lo instalé pero no tengo claro a dónde fue. ¿Tiene una GUI? – Chev

NDoc es también una opción. Pero iría con castillo de arena y eso fue lo que hice.

Fuente

2011-03-04 20:48:26 adt

He creado un proyecto de código abierto para exponerlos en páginas web Comprobar @AutoHelp

AUTOhelp lee los archivos XML Doc DLL &, genera páginas de ayuda y los expone a los usuarios. AutoHelp utiliza ASP.NET MVC 5, ASP.NET WebApi, TypeScript, jQuery y Bootstrap para ser una aplicación web moderna.

Fuente

2014-06-17 19:45:30 Raynald

Cómo formatear la documentación de Visual Studio XML para visualizarla en la web

Respuesta

Cuestiones relacionadas