CheckStyle es una herramienta de análisis del código fuente que al igual que PMD pertenece al conjunto de proyectos de software libre de SourceForge.net. CheckStyle automatiza el proceso de chequear el código Java frente a un estándar de codificación como el de “Sun Code Conventions”, liberando a las personas de esta tediosa pero importante tarea. CheckStyle es altamente configurable y puede soportar casi cualquier estándar de codificación.
Los chequeos estándar de CheckStyle se aplican al estilo general de codificación Java y no necesitan de librerías externas. Sin embargo, existen además chequeos opcionales por ejemplo para J2EE. CheckStyle define un conjunto de módulos con estructura jerárquica dentro de cada uno de los cuales se agrupan los chequeos relacionados entre si (convenciones de nombrado, violaciones de tamaño, modificadores, etc.). Si las reglas de validación proporcionadas por CheckStyle no cubren nuestras necesidades, podemos crear nuestras propias reglas de validación. Para ello CheckStyle proporciona una herramienta que nos muestra la estructura en árbol de una clase Java (Figura 1) permitiéndonos identificar cada uno de sus nodos y utilizarlos para describir la nueva regla.
Los chequeos estándar de CheckStyle se aplican al estilo general de codificación Java y no necesitan de librerías externas. Sin embargo, existen además chequeos opcionales por ejemplo para J2EE. CheckStyle define un conjunto de módulos con estructura jerárquica dentro de cada uno de los cuales se agrupan los chequeos relacionados entre si (convenciones de nombrado, violaciones de tamaño, modificadores, etc.). Si las reglas de validación proporcionadas por CheckStyle no cubren nuestras necesidades, podemos crear nuestras propias reglas de validación. Para ello CheckStyle proporciona una herramienta que nos muestra la estructura en árbol de una clase Java (Figura 1) permitiéndonos identificar cada uno de sus nodos y utilizarlos para describir la nueva regla.
Figura 1. Estructura en árbol de una clase Java
CheckStyle no analiza el código fuente del programa de manera directa, sino que transforma el código fuente en una representación en árbol que refleja la estructura del fichero. Para realizar esta función CheckStyle utiliza un parseador / generador llamado ANTLR que generará el árbol AST (Abstract Syntax Tree).
Finalmente, CheckStyle necesita de un archivo de configuración donde se especifiquen las reglas de validación que deben comprobarse así como los parámetros específicos de estas. En la Tabla 3 se observa un resumen de las características de CheckStyle.
Finalmente, CheckStyle necesita de un archivo de configuración donde se especifiquen las reglas de validación que deben comprobarse así como los parámetros específicos de estas. En la Tabla 3 se observa un resumen de las características de CheckStyle.
Resumen de la herramienta CheckStyle
URL: http://checkstyle.sourceforge.net/index.html
DESCRIPCIÓN: Estudia la calidad de la codificación usando para ello las guías de estilo más extendidas en J2EE.
MODO DE USO
- Descomprimir zip
- Añadir checkstyle-all-4.3.jar en el classpath
- La instrucción para lanzar el CheckStyle es:
VERSIÓN: Checkstyle 4.3java -D<property>=<value> \
com.puppycrawl.tools.checkstyle.Main \
-c <configurationFile> [-n <packageNameFile>] \
[-f <format>] [-p <propertiesFile>] [-o <file>] \
[-r <dir>] file...
LICENCIA: SOFTWARE LIBRE









