CheckStyle

RECU-0373 (Recurso Herramienta)

Descripción

CheckStyle es una herramienta de calidad de código encargada de validar los estándares de construcción de un desarrollo. Es decir, chequea la sintaxis del código fuente que ha sido desarrollado, encontrando las ocurrencias de un determinado problema que haya sido previamente configurado para ser detectado.

Uso en MADEJA

Se propone el uso de CheckStyle, tanto como plugin del entorno de desarrollo como plugin en el fichero de configuración del proyecto.

<?xml version="1.0" encoding="UTF-8"?>
<project>
...
  <!-- Reportes: Para agregar Información de la calidad del
  proyecto en el sitio web -->
  <reporting>
      <plugins>
          <!-- checkstyle para verificar el formato. Por defecto con
          las reglas de Sun (basada en la notación Camel)-->
          <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-checkstyle-plugin</artifactId>               
          </plugin>
          ...
  </reporting>

Al hora de elegir nuestras reglas de codificación podemos elegir entre algunas ya existentes o una propia.

  • config/sun_checks.xml - Sun Microsystems Definition (default).
  • config/maven_checks.xml - Maven Development Definitions.
  • config/turbine_checks.xml - Turbine Development Definitions.
  • config/avalon_checks.xml - Avalon Development Definitions.

Para seleccionar unas reglas de estilo para nuestro plugin añadiremos estas lineas al plugin:

<configuration>
    <configLocation>checkstyle.xml</configLocation>
</configuration>

Se puede consultar más datos sobre el reporting obtenido aquí.

  • Desde Sonar: Sonar aporta métricas de calidad, basadas en un conjunto de reglas configurables en formado PMD. Para consultar mas datos pulsar aquí.

Contenidos relacionados

Recursos
Área: Verificación » Verificación de Entrega Software
Código Título Tipo Carácter
RECU-0370 Reporting de Maven Herramienta Recomendado