Inspectopedia Help

TODO comment

Reports TODO comments in your code.

You can configure the format for TODO comments in Settings | Editor | TODO.

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.

Settings or Preferences | Editor | Inspections | General

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

Default: Selected

Availability

By default bundled with

CLion 2024.1, DataGrip 2024.1, DataSpell 2024.1, GoLand 2024.1, IntelliJ IDEA 2024.1, JetBrains Rider 2023.3, PhpStorm 2024.1, PyCharm 2024.1, Qodana for .NET 2023.3, Qodana for Go 2024.1, Qodana for JS 2024.1, Qodana for JVM 2024.1, Qodana for PHP 2024.1, Qodana for Ruby 2024.1, RubyMine 2024.1, WebStorm 2024.1 Writerside 2024.1

Can be installed with plugin

IDEA CORE, 241.SNAPSHOT

Last modified: 18 June 2024