Documentar Sitios Web Con SandCastle

Buenas a todos, Después de un descanso forzoso vuelvo a la carga, tengo varios Drafts pendientes, pero hoy me los eh saltado, básicamente por una razón sencilla, ayer estuve en el Webcast de El Bruno sobre Visual Studio Team System “Cabe mencionar que bruno es una eminencia”; miraba como el demostraba el proceso de documentar la aplicación con SandCastle en los Build.

La cuestión es que la documentación de una aplicación es algo importante, todos los sabemos, la mayoría usamos SandCastle para esto, pero este proceso se complica un poco cuando son aplicaciones Web; SandCastle requiere de la DLL y de un XML que una aplicación windows es fácil generar estos archivos.

Una aplicación tipo Web es muy diferente en ese aspecto, podemos generar las DLL usando la publicación directamente en VS o con la herramienta Aspnet_compliler, pero como generamos los archivos XML asociados a esas DLL’s.

Bueno para resolver este inconveniente momentáneo usamos la herramienta Documenting Web Projects que pertenece al pack de Sandcastle Styles. Demostrare como generar la documentación con estas herramientas.

Requisitos:

Para usar el Documenting Web Projects debemos registrar la dll EWSoftware.CodeCom.dll mediante el comando gacutil,

gacutil -i DotNet20WebWebCodeProvidersBinReleaseEWSoftware.CodeDom.dll

La otra forma es copiar la DLL a la carpeta bin de nuestro Web Site.

Usare Employee Info Starter Kit para genera un sitio Web, Cuando tenga mi sitio Web funcionando, agregare al archivo web.config el siguiente tag al tag de <configuration>

   1: <system.codedom>
   2:     <compilers>
   3:       <compiler language="c#;cs;csharp" extension=".cs" 
   4:                 compilerOptions="/docpath:C:Publishemployee-info-web-starter-kit"
   5:                 type="EWSoftware.CodeDom.CSharpCodeProviderWithDocs,
   6:                   EWSoftware.CodeDom, Version=1.0.0.0, Culture=neutral,
   7:                   PublicKeyToken=d633d7d5b41cbb65" />
   8:     </compilers>
   9:   </system.codedom>

 

Compilamos y publicamos para que nos genere la DLL con su respectivo archivo XML. Ahora ya podemos usar SandCastle Help File Builder para generar la documentación.

SHFB

Después de hacer los cambios respectivos, compilamos para generar el archivo de documentación.

SHFB1

S@ludos.

Romny Duarte.

Publicado por

Romny Duarte

Ingeniero de sistemas con experiencia en desarrollo web y móvil, geek, amante de la lectura y de la tecnología.

Un comentario en “Documentar Sitios Web Con SandCastle”

Deja un comentario

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