checkstyle

Checkstyle - Ferramenta de qualidade de código Java

A versão mais recente pode ser encontrada em lançamentos do GitHub ou no repositório Maven.

Cada compilação de commit de artefatos maven pode ser encontrada no repositório Maven Snapshot.

A documentação está disponível em formato HTML, consulte https://checkstyle.org/checks.html .

Índice

• Início rápido
• Contribuindo
• Feedback e suporte
• Javadoc
• Estilo de verificação do patrocinador
• Licenciamento

Início rápido

• Baixe nossa versão mais recente no GitHub ou adicione Checkstyle à sua construção no Maven Central.
• Leia nossa documentação para uso e configuração.

$ 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.

Contribuindo

Obrigado pelo seu interesse em contribuir com CheckStyle! Consulte as Diretrizes de Contribuição para obter informações sobre como contribuir para o projeto. Isso inclui criar problemas, enviar solicitações pull e configurar seu ambiente de desenvolvimento.

Instruções de construção

Consulte a documentação do CheckStyle para obter informações sobre como construir o projeto.

Feedback e suporte

• Visite nossa página de discussões, onde você pode fazer perguntas e discutir o projeto com outros usuários e colaboradores. Este é nosso método preferido de comunicação para tópicos como questões de uso e configuração, depuração e outros comentários.
• Stack Overflow é outro lugar para fazer perguntas sobre o uso do Checkstyle.
• Se você estiver interessado em contribuir para o projeto, você pode participar do nosso Discord Contributors Chat.
• Nosso Fórum dos Grupos do Google é uma lista de e-mails para discussão e suporte; no entanto, podemos demorar para responder nesse caso.

Javadoc

Dê uma olhada em nosso javadoc para ver nossa documentação da API.

Estilo de verificação do patrocinador

Checkstyle é um projeto de código aberto desenvolvido e mantido por voluntários. Se você achar o Checkstyle útil, considere patrocinar o projeto. Seu apoio nos ajuda a manter e melhorar o Checkstyle.

• Liberapay
• OpenCollective

Licenciamento

Checkstyle é licenciado sob a licença GNU LGPL v2.1. Checkstyle usa bibliotecas:

• ANTLR
• Apache Commons
• Google Goiaba
• Picocol