Чекстиль
![]() | В этой статье есть несколько проблем. Пожалуйста, помогите улучшить его или обсудите эти проблемы на странице обсуждения . ( Узнайте, как и когда удалять эти шаблонные сообщения )
|
![]() | |
Стабильная версия | 10.17.0
/ 26 мая 2024 г |
---|---|
Репозиторий | github |
Написано в | Ява |
Операционная система | Кросс-платформенный |
Тип | Статический анализ кода |
Лицензия | Меньшая стандартная общественная лицензия GNU |
Веб-сайт | контрольный стиль |
Чекстиль [ 1 ] — инструмент статического анализа кода , используемый при разработке программного обеспечения для проверки Java соответствия исходного кода указанным правилам кодирования .
Первоначально разработанный Оливером Берном еще в 2001 году, проект поддерживается командой разработчиков со всего мира.
Текущая стабильная версия — версия 10.17.0. [ 2 ] который поддерживает версии Java с 11 по 17. [ 3 ]
Преимущества и ограничения
[ редактировать ]Стиль программирования, принятый в проекте разработки программного обеспечения, может помочь гарантировать, что код соответствует передовым практикам программирования, что улучшает качество, читаемость и возможность повторного использования кода и может снизить стоимость разработки. Проверки, выполняемые Checkstyle, в основном ограничиваются представлением кода. Эти проверки не подтверждают правильность или полноту кода. Правила Checkstyle не являются стилем программирования, это просто правила форматирования кода.
Примеры доступных модулей
[ редактировать ]Checkstyle определяет набор доступных модулей, каждый из которых обеспечивает проверку правил с настраиваемым уровнем строгости (обязательный, необязательный...). Каждое правило может вызывать уведомления, предупреждения и ошибки. Например, Checkstyle может проверять следующее:
- Комментарии Javadoc для классов, атрибутов и методов;
- Соглашения об именах атрибутов и методов;
- Количество параметров функции;
- Длины линий;
- Наличие обязательных заголовков;
- Использование импорта и модификаторов области действия;
- Пробелы между некоторыми символами ;
- Практики построения классов;
- Множественные измерения сложности .
Использование
[ редактировать ]Checkstyle доступен в виде файла JAR , который можно запускать внутри виртуальной машины Java , или в виде задачи Apache Ant . Его также можно интегрировать в IDE или другие инструменты.
См. также
[ редактировать ]- Список инструментов для статического анализа кода
- EclipseCS — плагин Eclipse для проверки стиля.
- Checkstyle-IDEA — плагин Checkstyle для IntelliJ IDEA и Android Studio.
- SevNTU-Checkstyle. Архивировано 22 марта 2013 г. на Wayback Machine — расширение для EclipseCS с количеством проверок, которые не являются частью восходящего стиля проверки.
- Дополнения Checkstyle — дополнительные проверки Checkstyle
- Checkstyle для PHP — PHP-версия Checkstyle.
Ссылки
[ редактировать ]- ^ «Главная страница Checkstyle» . 2010 . Проверено 2 ноября 2010 г.
- ^ «checkstyle – Примечания к выпуску» . checkstyle.sourceforge.io . Проверено 27 мая 2024 г.
- ^ «checkstyle – Домашняя страница Checkstyle» . checkstyle.sourceforge.io . Проверено 27 мая 2024 г.
Внешние ссылки
[ редактировать ]