Improving Comments with the Comment Lint Plugin
Do you often have confusing comments in a project? Or do you want to make your documentation understandable to other developers? Then this article is for you.
Text quality checking in IntelliJ IDEA is poor. It allows you to detect some typos, but, in general, is not very useful. The Grazie plugin improves things, but only in spelling and grammar.
Luckily, there is now a Comment Lint plugin. It uses the Glvrd service, which detects more complex issues by highlighting readability and text cleanliness errors.
The plugin works in the background, analyzing Russian comments and suggesting ways to improve them.
Supported JetBrains Products
IntelliJ IDEA 2021.3.2 and above
PyCharm 2021.3.1 and above
GoLand 2021.3.2 and above
WebStorm 2021.3.1 and higher
AppCode 2021.3.1 and above
DataSpell 2021.3.1 and higher
Rider 2021.3.2 and above
Android Studio build 213.6461 and above
CLion 2021.3.1 and later
PhpStorm 2021.3.1 and above
DataGrip 2021.3.2 and above
RubyMine 2021.3.1 and above
We go to the settings Idea -> Plugins -> Available. Next, we write in the search for Comment Lint. Select, download it and agree to restart.
In demo mode, there is a limit of one request to the service per minute. The paid version is still in development, the key can be bought directly by contacting the site glvrd.ru.
Plugin source code is available at github.
You can install the plugin on Jetbrains Marketplace.