CheckStyle - ¿Que es el CheckStyle?- Reglas del CheckStyle

Hoy vamos a ver el CheckStyle, mas que nada un overview muy rápido para que entendamos para que sirve, en otros artículos vamos a hablar de su integración con el eclipse, pero eso mucho mas adelante... así que bueno manos a la obra.

¿Que es el CheckStyle?

Checkstyle es una herramienta de desarrollo que ayudar a los programadores a escribir código Java para que se adhiera a un estándar de codificación. Automatiza el proceso de comprobación de código Java. Esto lo hace ideal para los proyectos a los que se desea aplicar un estándar de codificación.

Checkstyle es altamente configurable y se puede hacer para apoyar casi cualquier estándar de codificación. De tal manera que se puedan suministrar diferentes estándares de código para su posterior comprobación mediante la herramienta.

Reglas del CheckStyle

El conjunto de reglas disponible es muy completo y está clasificado en los siguientes grupos:

Comentarios Javadoc: facilitar el mantenimiento pasa por comentar el código, pero luego los comentarios también hay que mantenerlos... CheckStyle tiene muchas reglas para los javadoc y es muy flexible. Te permite, por ejemplo, obligar a comentar los nombres de clases, todos los métodos menos los get/set y los atributos públicos.
Convenciones de nombres: puedes definir una expresión regular para el nombre de todo.
Cabeceras: expresiones regulares para la cabecera de los ficheros.
Imports: reglas para los import, como no usar *, imports sin usar, etc.
Violaciones de tamaño: define un máximo para el tamaño de tus clases, métodos, líneas y número de parámetros de un método.
Espacios en blanco: un montón de reglas para definir donde se ponen espacios en blanco y tabuladores en el código.
Modificadores: establece un orden para los modificadores y evita modificadores innecesarios.
Bloques: reglas para los bloques de código y sus llaves.
Problemas en la codificación: Acá hay de todo, desde malas prácticas tipo asignaciones internas y posibles fuentes de bugs como definir un método equals que no es el equals(Object), a cosas más estéticas o poco prolijas, como que el default sea el último elemento en un switch o paréntesis innecesarios.
Diseño de clases: varias reglas sobre el diseño de interfaces y clases, con especial atención en las excepciones.
Duplicados: te permite definir un mínimo de líneas para buscar código duplicado en tus clases.
Métricas: define máximos para métricas como complejidad ciclomática, complejidad de expresiones lógicas, npath, líneas de código seguidas sin comentar y dependencia de clases.
Misceláneo: variables final, indentación, un buscador de expresiones regulares y varias cosas más.
J2EE: reglas para EJBs.
Otros: internos a CheckStyle y activados por defecto.
Filtros: para eventos de auditoria del propio CheckStyle, no hace falta mirarlos.