Vision AG

blog visionag = new blog(post);

Documentacion: SandCastle

Posted by Vision AG en noviembre , 2007

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…. Lo que cuesta un poco, por lo menos a mi , es acostumbrarse a documetar en el codigo antes o despues , pero documentarlo al fin , 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 el tiempo mal llamado perdido documentando, es lo que en futuro cuando el cliente requiera alguna nueva funcionalidad/modificacion, nos permitira realizarlas. Porque una vez pasado el tiempo ni el que hizo el codigo se acuerda…’que era que hice aca mmm ‘ , y ni decirlo si trabajamos en equipos, esto pasa a ser una practica fundamental.Los pasos a seguir 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:

/// <summary>
        /// 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………….

Anuncios

2 comentarios to “Documentacion: SandCastle”

  1. Efrén said

    Si fue muy util más facil que estar leyendo la ayuda en inglés jeje

  2. evtb said

    Buen aporte, soy pésimo para la documentación pero esto lo solucionó.

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s

 
A %d blogueros les gusta esto: