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

Question

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

• Herramienta de documentación .NET
• Vsdocman

Estoy seguro de que hay más, solo enumero estos dos como ejemplos. También hay hojas de estilo XSLT simples para convertir el XML en documentación 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 de sandcastle / shfb funciona muy bien. Gracias a todos los que ayudaron.

Algunos comentarios:

1. NDOC parece estar desactualizado, las últimas actualizaciones son de 2005. Por eso me he saltado esto.
2. Se puede encontrar un hilo similar, también muy detallado, aquí: https://stackoverflow.com/questions/3082044/how-to-trurn-c-xml-doc-comments- into-somethingful ¡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 contiene hscomp.exe. Hay una versión 1.0 y 1.1, por lo que podría resolverlo, la versión 1.0 contiene el compilador. Ver Helixsoft y Social MSDN Para algunos detalles.
5. En mi caso, la webhelp generada no funciona correctamente con Chrome. Siempre recarga la página index.html.
6. los tema aquí Muestra cómo agregar el espacio de nombres infos en la documentación de sandcastle.
7. Actualización a partir de noviembre de 2012: para proyectos más pequeños que estoy usando Doxígeno - Me parece un poco más fácil configurar.

Answer 1

Estamos utilizando Sandcastle para Transformation & 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, además de la documentación del código fuente "promedio", puede agregar información adicional como la arquitectura del programa, patrones que deben seguirse o cualquier contenido de concepción adicional para su proyecto que no está vinculado directamente a una clase en su programa. Esto se puede hacer creando archivos XML adicionales con la ayuda del esquema de autoría de Microsoft (se puede editar con Visual Studio como el archivo XML y el esquema para él está disponible). Es bastante fácil comenzar con esas ambas herramientas para crear documentación como MSDN.

Hace mucho tiempo probé Docbook, que es casi lo mismo en el lado técnico (archivos XML que contienen la información y los archivos XSLT para transformarla en varios tipos de salida). Pero no era una opción para nosotros, porque no existe una transformación que pueda usar la documentación XML generada por Visual Studio (más la transformación del contenido conceptual fue bastante dolorosa para nosotros).

Answer 2

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

• NDOC
• Castillo de arena

Answer 3

Sandcastle + SHFB es un gran combo. Libre y genera HTML, CHM, etc.