Blog Jose Cullar

//Scrum Master, Tech Lead & Full Stack Developer

Generar documentación (CHM o Web) mediante Visual Studio y SandCastle.

por Jose el 9 abril, 2010

Para poder generar la documentación debes instalar el siguiente software:

Si tienes algún problema con las instalaciones, seguimiento de los pasos a seguir o para ampliar esta información, visita la ayuda de SandCastle aquí.

SandCastle permite crear tres tipos de documentación:

  • HtmlHelp1x: Se utiliza HTML Help Workshop generando un archivo CHM.
  • HtmlHelp2x: Necesario el SDK. Generación de documentación mediante un sitio web.
  • WebSite: Necesario el SDK. Generación de documentación mediante un sitio web.

Pasos a seguir para generar documentación:

1.- Genera el XML del proyecto del que quieres generar la documentación:

  • Abre la solución de proyectos y websites con Visual Studio.
  • Selecciona el proyecto del que quieres generar la documentación y accede a las propiedades mediante el botón derecho del ratón.
  • Accede a la segunda pestaña Compilar.
  • Selecciona la opción: Generar archivo de documentación XML.
  • Volver a generar el proyecto.

Para más información, visita: Generación de documentación XML para un proyecto.
Repite estos pasos por cada proyecto que desees incluir en la documentación.

2.-Crear un proyecto de documentación mediante SandCastle Help File Builder GUI

  • Crea un nuevo proyecto desde la interfaz de usuario (File -> New Project).
  • En el apartado Project Explorer: Botón derecho sobre Documentation Sources. Selecciona: Add Documentation Source…
  • Accede a la carpeta bin\Release o bin\Release del proyecto que has generado y selecciona el archivo XML.

Repite estos pasos por cada proyecto que desees incluir en la documentación.

3.-Genera el proyecto de documentación:

  • Antes, en el apartado Project Properties, configura las opciones de personalización para la generación de la documentación.
  • Compila el proyecto (Documentation -> Build Project).

Recuerda que el resultado de la compilación se guardará en la carpeta Help en la ruta donde hayas guardado el archivo de proyecto de SandCastle.

Ten en cuenta que para disponer de una documentación completa, los ensamblados deben estar debidamente comentados.

Deja un comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *