Documentacion: SandCastle

Hola como estan, en este post les quiero comentar que estuve realizando un proyecto con un amigo y utilizamos esta herramienta para documentar y la verdad nos ha resultado muy util.

Bueno utilizamos sandcastle y para generar la doc usamos una gui para esta herramienta que es sandcastle help file builder que la pueden bajar del codeplex.... Es cierto que a casi todos nos cuesta un poco (por lo menos a mi) acostumbrarnos a documetar en el codigo , uno siempre dice "si despues lo hago" y deja pasar , es cierto que a veces los tiempos son acotados , pero uno tiene que entender que este tiempo documentando (mal llamado tiempo perdido por algunos), es lo que en futuro cuando el usuario/cliente requiera alguna nueva funcionalidad/modificacion, esta modificacion la puede realizar cualquier persona no necesariamente la/las que desarrollo por primera vez. Es en estos momentos donde vemos la necesidad y vemos que esto deberia se una practica fundamental.Los pasos a seguir para generar esta documentacion son :

1)Para que VS genere la doc en los xml debemos especificarlo en nuestro codigo antes de genrarlos con sandcastle help file builder, por ej:

/// 

     /// Muestra un formulario dentro de un Mdi
     /// </summary>
     /// <param name="formulario">Formulario a Mostrar</param>
     /// <param name="MdiParent">Formulario Mdi padre</param>
     public static void MostrarForm(frmEntity formulario, Form MdiParent, bool permitirSeleccionar)
     {
         if (MdiParent.IsMdiContainer)
         {
             formulario.MdiParent = MdiParent;
             formulario.WindowState = FormWindowState.Normal;
         }
         formulario.PermitirSeleccionar = permitirSeleccionar;
         if (MdiParent.IsMdiContainer) formulario.Show(); else formulario.ShowDialog();
     }

2) En las propiedades de cada proyecto de nuestra solucion habilitamos para que se genere el archivo xml correspondiente

project(tu proyecto)-->properties-->build --> xml documentation file

generarlo..

3)Abrimos sandcastle help file builder y cargamos los xml generados anteriormente, tenemos varias opciones que podemos configurar, por ejemplo generar chm / html o ambos, una vez finalizado ... listo

Espero que les resulte util.............