Incrementando la calidad del código
Introducción
Checkstyle es una herramienta de desarrollo que ayuda a los programadores a escribir código Java adecuándose a estándares de codificación establecidos, facilitando para ello la automatización del proceso de chequeo del código generado.
Checkstyle incorpora las recomendaciones de Sun sobre el estilo de código, pero estas reglas pueden ser redefinidas e incluso creadas completamente desde cero por el usuario, lo que convierte este plug-in en adaptable al estilo de codificación interno de nuestro entorno, sea cual sea.
Introducción
Checkstyle es una herramienta de desarrollo que ayuda a los programadores a escribir código Java adecuándose a estándares de codificación establecidos, facilitando para ello la automatización del proceso de chequeo del código generado.
Checkstyle incorpora las recomendaciones de Sun sobre el estilo de código, pero estas reglas pueden ser redefinidas e incluso creadas completamente desde cero por el usuario, lo que convierte este plug-in en adaptable al estilo de codificación interno de nuestro entorno, sea cual sea.
Integración con IDEs
Checkstyle se integra a varios IDEs a través de distintos plugins de terceros.
Algunos de los más conocidos son:
Instalación del plug-in de Checkstyle para Eclipse
- En el Eclipse ir a Help->Software Updates...
- Agregar el sitio http://eclipse-cs.sf.net/update/
- Marcar la versión del plugin que se desea intalar
- Rever y confirmar los plugins a instalar.
- Reiniciar el Eclipse.
Configuración
Entramos en Window->Preferences->Checkstyle para acceder a
las opciones de configuración del Checkstyle. Checkstyle utiliza por omisión las
convenciones de Sun (Sun Checks), pero podemos modificarlas o crear un nuevo conjunto de reglas fácilmente. El plugin
también incluye un conjunto de normas basadas en las convenciones de
Sun, ligeramente modificadas para adaptarse mejor a la configuración por
defecto del formateador de código de Eclipse: Sun Checks (Eclipse).
Para activar Checkstyle para un proyecto haremos clic con el botón derecho sobre él, seleccionaremos Properties y en la sección dedicada a Checkstyle marcaremos Checkstyle active for this project. En esta sección podemos seleccionar también el conjunto de normas que nuestro proyecto debe de seguir, asi como posibles excepciones.
Para activar Checkstyle para un proyecto haremos clic con el botón derecho sobre él, seleccionaremos Properties y en la sección dedicada a Checkstyle marcaremos Checkstyle active for this project. En esta sección podemos seleccionar también el conjunto de normas que nuestro proyecto debe de seguir, asi como posibles excepciones.
Utilización
Una vez activado Checkstyle para el proyecto veremos los Warnings
relativos a los estándares de código en la vista Problems, asà como en
el propio editor, donde las advertencias se muestran con fondo amarillo.
También podemos recurrir a la vista Checkstyle violations (Window->Show view->Checkstyle->Checkstyle violations), que está más
especializada y permite agrupar los problemas, generar informes en
formato rtf, y lanzar la vista Checkstyle Violations Chart, con un
gráfico de tarta con los distintos problemas encontrados en el código.
No hay comentarios:
Publicar un comentario