Vision AG

blog visionag = new blog(post);

Analizador de Codigo (best-practices)

Posted by Vision AG en marzo , 2008

FxCop es una herramienta  free de analisis de codigo para .net. Esta herraminenta analiza el asembly y verifica si las guidelines fueron aplicadas.
Las guidelines se encuentran en .NET Framework SDK\Reference\Design Guidelines for Class Library Developers. Estas traen información y buenas prácticas sobre: nomenclaturas, patrones de manejo de errores, patrones de diseño, entre otros temas.
Utilizar este analizador no nos asegura realizar codigo 100% seguro, pero si nos permite realizar un codigo mas robusto y de mayor calidad, reduciendo asi los riesgos.Posee una interfaz bastante sencilla, simple de usar y amigable, puden descargarlo desde aqui ,
tambien posee una version de linea de comandos que no la probe.

Pruebenla y despues me cuentan…

Anuncios

Posted in .NET, dotNetTools | Etiquetado: | Leave a Comment »

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

Posted in dotNetTools | Etiquetado: | 2 Comments »

Documentación de código para .NET 2.0

Posted by Vision AG en septiembre , 2007

Con la muerte de NDOC, los desarrolladores que utilizamos Visual Studio 2005 quedamos sin una harramienta para generar la documentacion de nuestras clases.

Por suerte la gente de microsoft decidio suplir esta necesidad de los desarrolladores y libero una herramienta –> SandCastle, un proyecto de generacion de documentacion.

Aun no esta muy madura y no es tan simple, hay que realizar muchas cosas de forma manual es lo que lei en la web, pero como dicen “es lo que hay” . Recien la estoy instalando para probar despues les cuento bien los pro y contras con los que me encontre

Algunas de sus caracteristicas son:

  • Soporta generics y framework 2.0
  • Posee 2 principales componentes MrefBuilder y Build Assembler
  • MrefBuilder genera el xml mediante reflexión.
  • BuildAssembler es el generador de la documentación y las transformaciones de estilo.

Requerimientos de Software

  • Microsoft .NET Framework Version 2.0, diponible aqui
  • HTML Help Workshop, disponible aqui

Posted in dotNetTools | Leave a Comment »