c# - documentar - generar documentacion visual studio 2017

¿Cómo exporto la documentación del código en C#/ VisualStudio 2008?

Question

Siempre me he esforzado por escribir bonitos comentarios de código para clases y métodos con la sintaxis C # xml. Siempre esperé poder exportarlos fácilmente más adelante.

Hoy en realidad tengo que hacerlo, pero tengo problemas para descubrir cómo. ¿Se me escapa algo? Quiero ir a Menu-> Build-> Build Code Documentation ...

EDITAR: Esta es una tarea bastante desalentadora, los enlaces de NDoc y Sandcastle probablemente sean realmente el camino a seguir, pero aún así es un gran desastre, especialmente si lo único que quieres hacer es exportarlo rápidamente a html :(

EDIT2: Este enlace tiene un xslt fácil para exportaciones rápidas y sucias: http://www.codeproject.com/KB/XML/XMLDocStylesheet.aspx

Answer 1

En realidad está en las propiedades del proyecto. Haga clic en la pestaña Crear, en la sección Salida, en el archivo de documentación XML e ingrese el nombre del archivo. Se construirá en cada construcción del proyecto.

Después de eso, puedes construir la ayuda real con Sandcastle .

Answer 2

Le recomendaría encarecidamente que eche un vistazo a DocProject, que está específicamente diseñado para que el uso de Sandcastle sea menos doloroso.

Answer 3

Puedes probar NDOC o SandCastle si no te importa utilizar herramientas de terceros.

Answer 4

Tenga cuidado si usa LINQ to SQL, ya que no podrá agregar fácilmente comentarios sostenibles a los objetos generados automáticamente.

Answer 5

Sandcastle funciona bastante bien para generar documentación y admite un par de formatos diferentes para la generación. Por lo que yo sé, no hay ninguna integración de Visual Studio para ello, pero hay una SandcastleGUI disponible.

Answer 6

El proyecto original de NDoc (mencionado por otros) está muerto, pero hay un nuevo proyecto llamado NDoc3 .

NDoc3 es compatible con .NET 2.0 - 3.5. Actualmente está disponible como una versión beta y funcionó muy bien para mí. No estoy seguro si el proyecto aún está activo: la última versión beta se lanzó en abril de 2009.

Answer 7

Último comentario, pero vale la pena agregar que, aunque Sandcastle está desactivado, el Creador de archivos de ayuda de Sandcastle sigue en desarrollo activo, y me pareció muy potente y directo sumergirme cuando se trata solo de esta situación: instalar en .chm y .html. /.asp de salida en un par de horas.