Улучшаем комментарии с помощью плагина Comment Lint

Часто бывает, что у вас запутанные комментарии в проекте? Или вы хотите сделать свою документацию понятным другим разработчикам? Тогда эта статья для вас.

Предыстория

Проверка на качество текста в IntelliJ IDEA скудная. Она позволяет обнаруживать некоторые опечатки, но, в целом, не очень полезна. Плагин Grazie улучшает ситуацию, но только в орфографии и грамматике.

К счастью, теперь есть плагин Comment Lint. Он использует сервис Glvrd, который обнаруживает более сложные проблемы: подсвечивая ошибки читаемости и чистоты текста.

Возможности

Плагин работает в фоновом режиме, анализируя русские комментарии и предлагая варианты их улучшения.

Поддерживаемые продукты JetBrains

• IntelliJ IDEA 2021.3.2 и выше

• PyCharm 2021.3.1 и выше

• GoLand 2021.3.2 и выше

• WebStorm 2021.3.1 и выше

• AppCode 2021.3.1 и выше

• DataSpell 2021.3.1 и выше

• Rider 2021.3.2 и выше

• Android Studio build 213.6461 и выше

• CLion 2021.3.1 и выше

• PhpStorm 2021.3.1 и выше

• DataGrip 2021.3.2 и выше

• RubyMine 2021.3.1 и выше

Установка

Отправляемся в настройки Idea -> Plugins -> Available. Далее пишем в поиске Comment Lint. Выбираем, загружаем его и соглашаемся на перезапуску.

Цена

В демо режиме стоит ограничение на один запрос к сервису в минуту. Платная версия пока в разработке, ключ можно купить напрямую обратившись к сайту glvrd.ru.

Ссылки

Исходный код плагина доступен на гитхабе.

Установить плагин можно на Jetbrains Marketplace.