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

Question

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

Hoy tengo que hacerlo, pero tengo problemas para descubrir cómo.¿Se me escapa algo?Yo quiero ir Menú->Construir->Documentación del código de compilación, pero no hay ninguna opción para hacer eso allí.

Answer 1

En realidad está en las propiedades del proyecto.Pestaña Generar, sección Salida, archivo de documentación XML e ingrese el nombre del archivo.Se construirá en cada compilación del proyecto.

Después de eso, puedes crear la ayuda real con Castillo de arena.

Answer 2

Tu podrías intentar NDOC o Castillo de arena si no le importa utilizar herramientas de terceros.

Answer 3

Castillo de arena Funciona bastante bien para generar documentación y admite un par de formatos diferentes para la generación.Hasta donde yo sé, no existe ninguna integración de Visual Studio para esto, pero hay una Castillo de arenaGUI por lo que está disponible.

Answer 4

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

Answer 5

Comentario tardío, pero vale la pena agregar que, aunque Sandcastle está suspendido, el Generador de archivos de ayuda de Sandcastle permanece en desarrollo activo, y lo encontré muy poderoso y sencillo de abordar cuando se trata de esta situación: instalarlo en una salida enriquecida .chm y .html/.asp en un par de horas.

Answer 6

El proyecto NDoc original (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 versión beta y funcionó muy bien para mí.No estoy seguro de si el proyecto sigue activo: la última versión beta se lanzó en abril de 2009.