checkstyle

Checkstyle — инструмент качества Java-кода

Последнюю версию выпуска можно найти в выпусках GitHub или в репозитории Maven.

Каждую фиксируемую сборку артефактов Maven можно найти в репозитории Maven Snapshot.

Документация доступна в формате HTML, см. https://checkstyle.org/checks.html.

Оглавление

• Быстрый старт
• Содействие
• Обратная связь и поддержка
• Javadoc
• Спонсор
• Лицензирование

Быстрый старт

• Загрузите нашу последнюю версию с GitHub или добавьте Checkstyle в свою сборку из Maven Central.
• Прочтите нашу документацию по использованию и настройке.

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

Содействие

Благодарим за ваш интерес к вкладу в CheckStyle! Пожалуйста, ознакомьтесь с Руководством по вкладам, чтобы получить информацию о том, как внести свой вклад в проект. Это включает в себя создание проблем, отправку запросов на включение и настройку среды разработки.

Инструкции по сборке

Пожалуйста, обратитесь к документации CheckStyle для получения информации о том, как построить проект.

Обратная связь и поддержка

• Посетите нашу страницу обсуждений, где вы можете задавать вопросы и обсуждать проект с другими пользователями и участниками. Это наш предпочтительный метод общения по таким темам, как вопросы использования и настройки, отладка и другие отзывы.
• Stack Overflow — еще одно место, где можно задать вопросы об использовании Checkstyle.
• Если вы заинтересованы в участии в проекте, вы можете присоединиться к нашему чату участников Discord.
• Наш форум групп Google — это список рассылки для обсуждения и поддержки; однако мы можем задержаться с ответом.

Javadoc

Взгляните на нашу документацию Javadoc, чтобы просмотреть документацию по API.

Спонсор

Checkstyle — это проект с открытым исходным кодом, который разрабатывается и поддерживается волонтерами. Если вы считаете Checkstyle полезным, рассмотрите возможность спонсирования проекта. Ваша поддержка помогает нам поддерживать и улучшать Checkstyle.

• Либерапей
• OpenCollective

Лицензирование

Checkstyle распространяется по лицензии GNU LGPL v2.1. Checkstyle использует библиотеки:

• АНТЛР
• Апач Коммонс
• Гугл Гуава
• Пикокли