StyleCop

En esta entrada quiero comentarles sobre una herramienta llamada StyleCop que les va a ser útil para revisar la nomenclatura de nuestro código C#. Esta herramienta de Microsoft nos permite analizar nuestro código de acuerdo a una serie de estilos y reglas de consistencia – para más información revisar la documentación de la herramienta.

Actualmente se encuentra en la versión 4.3.3.0 y una de las cosas positivas que tiene es la integración de la herramienta con Visual Studio 2005 y Visual Studio 2008. Lo negativo es que aún no tiene soporte para el lenguaje Visual Basic.

Enlaces de interés:

Descarga : instalador y documentación.
Información : información de la versión actual.

Paso a paso:

Una vez instalada la herramienta ya tendremos habilitada la opción para correr SytelCop sobre nuestro código. Para ello hacemos click derecho sobre nuestro archivo (también podemos hacerlo sobre el proyecto o solución) y seleccionamos la opción “Run StyleCop”.

Ejecutando StyleCop

Ejecutando StyleCop

Ahora vamos a evaluar la siguiente clase. Uno podría decir el código es “correcto”, ya que, en primer medida, nos devuelve el resultado esperado:

Código no analizado con StyleCop

Código no analizado con StyleCop

Sin embargo cuando ejecutamos StyleCop, nos detecta una serie de advertencias (como por ejemplo que falta el XMLComment de la clase y del método):

Resultado del análisis de StyleCop

Resultado del análisis de StyleCop

Procedemos a corregir cada una de las advertencias y nuestro código “corregido” queda de la siguiente forma:

Código corregido

Código corregido

Ojo que no siempre es necesario seguir al pie de la letra todas las advertencias, ya que muchas de ellas a veces no se corresponden con lo que queremos hacer (por ejemplo que la descripción de los atributos de una clase comiencen con el texto “Get or sets” , es decir en inglés, y esto no siempre es válido, por ejemplo sí estamos codificando en español). Para estos casos tenemos la opción de deshabilitar reglas en el proyecto o directamente ignorarlas.

Para deshabilitar las reglas hacemos click derecho sobre el proyecto y clickeamos en la opción “StyleCop Setting”. Buscamos la/s regla/s que queremos deshabilitar y las simplemente las des-tildamos (de esta forma no volverán a validarse la próxima vez que hagamos el análisis del código):

Deshabilitando reglas

Deshabilitando reglas

Espero que les sea útil!

Anuncios

Un comentario en “StyleCop

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