Comprobar estilo

Comprobar estilo

Checkstyle Logo.png
Datos básicos

Versión actual  8.40
(31 de enero de 2021)
Sistema operativo multiplataforma
lenguaje de programación Java
categoría Análisis de código estático
Licencia Licencia pública general reducida GNU
https://checkstyle.org

Checkstyle es una herramienta utilizada en el desarrollo de software para el análisis de código estático para comprobar el estilo de programación del código fuente de Java .

área de operación

El estilo de programación utilizado en los proyectos de desarrollo de software puede mejorar la calidad, la legibilidad y la reutilización del software. Esto puede reducir los costos de desarrollo y mantenimiento del software. Checkstyle puede realizar una serie de pruebas automatizables del estilo de programación. Estas pruebas pueden activarse y desactivarse individualmente y configurarse para el estilo de programación definido en el proyecto a probar. La falla de una prueba conduce a un error o una advertencia, dependiendo de la configuración de la prueba. Checkstyle se puede ampliar para incluir sus propias pruebas.

Checkstyle no es una herramienta para la detección automática de errores de programación. Sin embargo, al señalar estilos de programación no deseados, los errores de programación se pueden encontrar o evitar con la ayuda de Checkstyle.

Checkstyle tampoco es una herramienta para la eliminación automática de estilos de programación incorrectos. Los programas de formato de código fuente se pueden utilizar para errores de formato de código .

Módulos

Checkstyle viene con una serie de módulos que contienen exámenes sobre temas específicos. Estos módulos se pueden ampliar para incluir sus propios módulos con sus propios exámenes.

  • Anotación: comprueba el uso correcto de las anotaciones.
  • Verificaciones de bloques: verificaciones de bloques de código
  • Diseño de clases: exámenes de diseño de software
  • Codificación: revisiones de las pautas generales de codificación
  • Código duplicado: comprueba la presencia de códigos duplicados (hasta la versión 6.1.1)
  • Encabezados: verifica los encabezados de los archivos de código fuente
  • Importaciones: comprobaciones para el uso de importaciones
  • Comentarios de Javadoc: verifica la existencia, integridad y formato de los comentarios de Javadoc
  • Métricas: verifica el cumplimiento de varias métricas de software
  • Varios: varios exámenes que no se pueden clasificar en los otros módulos
  • Modificadores: verifica el uso correcto de modificadores de acceso
  • Convenciones de nomenclatura: verifica el cumplimiento de las convenciones de nomenclatura definidas.
  • Regexp: comprobaciones que se pueden configurar mediante expresiones regulares
  • Violaciones de tamaño: verifica el tamaño de las clases, los métodos, el número de parámetros, etc.
  • Espacio en blanco: comprueba para formatear el código para espacios

compromiso

Checkstyle se entrega como un archivo Java y, por lo tanto, puede ejecutarse en cualquier máquina virtual Java y como una tarea de Apache Ant . Varias herramientas proporcionan complementos para Checkstyle, incluidos Eclipse , Apache Maven o SonarQube .

historia

Checkstyle fue desarrollado originalmente por Oliver Burn en 2001 y ahora varios desarrolladores lo mantienen y desarrollan como software de código abierto.

Alternativas

En el entorno Java, además de Checkstyle, PMD y FindBugs se suelen utilizar para fines similares a Checkstyle. Consulte también Lista de herramientas para análisis de código estático .

enlaces web