Instalación de SandCastle

Para instalar SandCastle podemos hacer uso de el instalador guiado que provee el fabricante el cual podemos encontrar aquí.

Al usar la instalación guiada, puedes omitir la sección de Requerimientos teniendo especial cuidado en los pasos que solicita la instalación.

Requerimientos

La última versión de SandCastle Help File Builder and Tools la puedes encontrar en el respositio GitHub del fabricante aquí (V2017.5.15.0 cuando se creó esta documentación). Se requiere .NET Framework 4.5 o superior para ejecutar las herramientas.

Para usar el generador de la documentación, se requieren las siguientes herramientas adiconales en función del tipo de archivo (.chm y .mshc) que desee generar:

• El HTML Help Workshop para construir archivos HTML Help 1 (.chm).
• El MS Help Library Viewer para la instalación y visualización de archivos MS Help Viewer (.mshc). Este es instalado como parte de la instalación de Visual Studio.

Adiciones recomendadas

Las siguientes herramientas son opcionales pero muy utiles a la hora de generar la documentación del código:

• Si requieres un corrector ortográfico, se recomienda el uso de la extensión Visual Studio Spell Checker que puedes encontrar en Visual Studio Marketplace, o directamente desde Visual Studio en el menú [Herramientas > Extensiones y Actualizaciones ...] y buscar la extensión como lo muestra la siguiente imagen:
• Para crear comentarios XML de manera automática en el código de Visual Studio puedes usar el complemento GhostDoc en su versión Community.