TODO comment
Reports TODO comments in your code.
You can configure the format for TODO comments in .
Locating this inspection
- By ID
Can be used to locate inspection in e.g. Qodana configuration files, where you can quickly enable or disable it, or adjust its settings.
TodoComment- Via Settings dialog
Path to the inspection settings via IntelliJ Platform IDE Settings dialog, when you need to adjust inspection settings directly from your IDE.
Enable the Only warn on TODO comments without any details option to only warn on empty TODO comments, that don't provide any description on the task that should be done. Disable to report all TODO comments.
Inspection ID: TodoComment
Inspection options
Here you can find the description of settings available for the TODO comment inspection, and the reference of their default values.
- Only warn on TODO comments without any details
Option ID:
onlyWarnOnEmptyDefault value:
Selected
Suppressing Inspection
You can suppress this inspection by placing the following comment marker before the code fragment where you no longer want messages from this inspection to appear:
More detailed instructions as well as other ways and options that you have can be found in the product documentation:
Inspection Details | |
|---|---|
By default bundled with: | CLion 2025.2, DataGrip 2025.2, DataSpell 2025.2, GoLand 2025.2, IntelliJ IDEA 2025.2, JetBrains Rider 2025.2, PhpStorm 2025.2, PyCharm 2025.2, Qodana for .NET 2025.2, Qodana for Go 2025.2, Qodana for JS 2025.2, Qodana for JVM 2025.2, Qodana for PHP 2025.2, Qodana for Ruby 2025.2, RubyMine 2025.2, WebStorm 2025.2 |