checkstyle

Checkstyle: herramienta de calidad de código Java

La última versión se puede encontrar en Lanzamientos de GitHub o en el repositorio de Maven.

Las compilaciones de artefactos de Maven para cada confirmación se pueden encontrar en el repositorio de instantáneas de Maven.

La documentación está disponible en formato HTML, consulte https://checkstyle.org/checks.html.

Tabla de contenido

• Inicio rápido
• Contribuyendo
• Comentarios y soporte
• javadoc
• Estilo de control del patrocinador
• Licencias

Inicio rápido

• Descargue nuestra última versión de GitHub o agregue Checkstyle a su compilación desde Maven Central.
• Lea nuestra documentación para uso y configuración.

$ cat config.xml
< ? xml version= " 1.0 " ? >
< ! DOCTYPE module PUBLIC
          " -//Puppy Crawl//DTD Check Configuration 1.3//EN "
          " https://checkstyle.org/dtds/configuration_1_3.dtd " >
< module name= " Checker " >
  < module name= " TreeWalker " >
    < module name= " FallThrough " / >
  < /module >
< /module >

$ cat Test.java
class Test {
  public void foo () {
    int i = 0 ;
    while (i > = 0) {
      switch (i) {
        case 1:
        case 2:
          i++ ;
        case 3: // violation ' fall from previous branch of the switch '
          i++ ;
      }
    }
  }
}

$ java -jar checkstyle-10.18.1-all.jar -c config.xml Test.java
Starting audit...
[ERROR] Test.java:9:9: Fall through from previous branch of switch statement [FallThrough]
Audit done.
Checkstyle ends with 1 errors.

Contribuyendo

¡Gracias por su interés en contribuir a CheckStyle! Consulte las Pautas de contribución para obtener información sobre cómo contribuir al proyecto. Esto incluye crear problemas, enviar solicitudes de extracción y configurar su entorno de desarrollo.

Instrucciones de construcción

Consulte la documentación de CheckStyle para obtener información sobre cómo construir el proyecto.

Comentarios y soporte

• Visite nuestra página de debates, donde puede hacer preguntas y discutir el proyecto con otros usuarios y contribuyentes. Este es nuestro método preferido de comunicación para temas como preguntas de uso y configuración, depuración y otros comentarios.
• Stack Overflow es otro lugar para hacer preguntas sobre el uso de Checkstyle.
• Si está interesado en contribuir al proyecto, puede unirse a nuestro chat de contribuyentes de Discord.
• Nuestro foro de Grupos de Google es una lista de correo para debates y soporte; sin embargo, es posible que tardemos en responder allí.

javadoc

Eche un vistazo a nuestro javadoc para ver nuestra documentación API.

Estilo de control del patrocinador

Checkstyle es un proyecto de código abierto desarrollado y mantenido por voluntarios. Si Checkstyle le resulta útil, considere patrocinar el proyecto. Su apoyo nos ayuda a mantener y mejorar Checkstyle.

• Liberapay
• Colectivo Abierto

Licencias

Checkstyle tiene la licencia GNU LGPL v2.1. Checkstyle utiliza bibliotecas:

• antlr
• Apache comunes
• Google guayaba
• Picoclí