Hacemos uso de sandcastle (y SHFB) para generar documentación de biblioteca de clase a partir de comentarios XML en línea. Es una gran herramienta para mantener una referencia completa y profesional + documentación general, que incluye correct code samples.¿Podemos acelerar el castillo de arena?
Desafortunadamente, también es lento. Es, de lejos, el paso más lento de nuestra versión automatizada, y está empezando a doler. ¿Hay alguna forma de acelerarlo?
El grupo de discusión en CodePlex es bastante activo y conocedor. Aquí hay una publicación semi sobre el tema (sin ayuda): http://sandcastle.codeplex.com/Thread/View.aspx?ThreadId=32267
Si tiene SdkLinkType = Msdn (consulte las propiedades de su proyecto SHFB) sandcastle se conecta a la documentación de MSDN mediante el servicio web. Eso puede reducirse en caso de problemas de conexión. Puede intentar establecer SdkLinkType = None para desactivar la creación de enlaces de MSDN (en ese caso, no tendrá enlaces a MSDN en su ayuda). En mi caso, eso mejoró mi tiempo de construcción 5 veces (2 minutos en lugar de 10 minutos).
Le recomiendo que use [Live Documenter] (http://theboxsoftware.com/products/live-documenter/ "Live Documenter") para ver su documentación rápidamente. El programa solo ve su documentación desde el archivo XML que se genera en cada compilación. Cuando esté satisfecho con su documentación, use el castillo de arena para construirlo. –
@JaredBeach: El problema es cuando Sandcastle es uno de muchos pasos ejecutados al preparar una compilación (automatizado por un script, por supuesto). Vista previa de la documentación puede que ni siquiera sea un objetivo allí; Sandcastle simplemente se ejecuta como una de las muchas herramientas al ensamblar los archivos de lanzamiento por cualquier motivo. –