c# - sharp - generar documentacion visual studio 2017

Generar archivos HTML/Ayuda de la documentación VS 2010 C#XML

Question

Estoy buscando una buena herramienta para crear archivos HTML / Ayuda de mi documentación VS2010 XML. He encontrado algunas herramientas comerciales, como

• Herramienta de documentación .Net
• VSDocman

Estoy seguro de que hay más, simplemente enumero estos dos como ejemplos. También hay hojas de estilos XSLT simples para convertir la documentación de XML a HTML.

¿Qué estás usando, por ejemplo, hay una herramienta gratuita para hacer la conversión, tal vez como complemento? Solo para aclarar, básicamente, he encontrado dos tipos de herramientas:

1. Los que convierten el archivo de documentación XML en diferentes formatos de destino, esto es lo que estoy buscando.
2. Herramientas que me ayudan a generar la documentación XML en el código fuente. Esto no es (!) Lo que estoy buscando.

Gracias por tu ayuda.

El combo Sandcastle / SHFB funciona muy bien. Gracias a todos los que ayudaron.

Algunas observaciones:

1. NDoc parece estar desactualizado, las últimas actualizaciones son de 2005. Es por eso que me salté esto.
2. Un hilo similar, también muy detallado, se puede encontrar aquí: ¿Cómo convertir C # Xml Doc-Comentarios en algo útil? ¡Gracias por la pista!
3. Hay algunas fuentes para Sandcastle, la última versión que he encontrado se encuentra aquí: http://sandcastle.codeplex.com/
4. Para generar MsHelp2 tuve que instalar VS 2008 SDK que contenía hscomp.exe . Hay una versión 1.0 y 1.1, por lo que pude deducir, la versión 1.0 contiene el compilador. Consulte Helixsoft y Social MSDN para obtener más información.
5. En mi caso, la WebHelp generada no funciona correctamente con Chrome. Siempre recarga la página index.html.
6. El tema aquí muestra cómo agregar infos de espacio de nombres en la documentación de Sandcastle.
7. Actualización a partir de noviembre de 2012: para proyectos más pequeños, estoy usando Doxygen : me resulta un poco más fácil de configurar.

Answer 1

Dos herramientas gratuitas más que permiten la creación de documentación a partir de comentarios Xml:

• NDoc
• Castillo de arena

Answer 2

Estamos utilizando Sandcastle para la transformación y Sandcastle Help File Builder como una interfaz de usuario para administrar los proyectos de ayuda. En mi opinión, la belleza de Sandcastle y SHFB es que, junto a la documentación del código fuente "promedio", puede agregar información adicional como la arquitectura del programa, los patrones que se deben seguir o cualquier contenido conceptual adicional para su proyecto que no esté vinculado directamente a una clase en tu programa. Esto se puede hacer creando archivos xml adicionales con la ayuda del Microsoft Authoring Schema (se puede editar con Visual Studio ya que el archivo xml y el esquema están disponibles). Es bastante fácil comenzar con esas dos herramientas para crear MSDN como documentación.

Hace mucho tiempo probé docbook que es casi lo mismo en el aspecto técnico (archivos xml que contienen la información y archivos xslt para transformarlo en varios tipos de salida). Pero no era una opción para nosotros, porque no hay transformación por ahí que pueda usar la documentación xml generada por Visual Studio (además la transformación del contenido conceptual fue muy dolorosa para nosotros).

Answer 3

Sandcastle + SHFB son un gran combo. Gratis y genera html, chm, etc.