PyCharm
 
Get PyCharm

TODO comments

Last modified: 22 October 2024

Sometimes, you need to mark parts of your code for future reference: areas of optimization and improvement, possible changes, questions to be discussed, and so on. PyCharm lets you add special types of comments that are highlighted in the editor, indexed, and listed in the TODO tool window. This way you and your teammates can keep track of issues that require attention.

TODO comments example

By default, there are two patterns recognized by PyCharm: TODO and FIXME in both lower and upper case. These patterns can be used inside line and block comments of any supported file type. You can modify the default patterns or add your own patterns if necessary.

TODO comments example
The TODO tool window