Working with TODO in PhpStorm

When working on a project, it’s often needed to create a list of tasks for yourself or your team mates. While usually these tasks are described in an issue tracker like YouTrack, some tasks are either too small or too code-specific to describe in an issue tracker. In such case, adding todo comments in source code makes sense.

Many developers already use comments in their code to describe these small tasks, typically using a statement like the following:

PhpStorm recognizes these comments and will automatically display them in the TODO tool Window (Alt+6 or View | Tool Windows | TODO).

From the TODO tool window, we can select a todo comment and navigate to it by double-clicking it or using the Jump to Source context menu (F4).

There are a lot more features in PhpStorm around todo comments. Check our tutorials page for advanced topics like todo pattern recognition, live templates and todo filtering.

As always, we appreciate your feedback in the comments below or in our forums!

Develop with pleasure!
– JetBrains PhpStorm Team

About Maarten Balliauw

Maarten Balliauw is a Developer Advocate at JetBrains, working on .NET tools. He focuses on .NET, Azure, web technologies and application performance. Maarten is a frequent speaker at various national and international events. In his free time, he brews his own beer. Follow him on Twitter or check his personal blog.
This entry was posted in Cool Feature and tagged , , , , , , . Bookmark the permalink.
  • doerteDev

    Technical dept: having hundrets of TODOs in your project, by mistake push the F4 Button, wait for Minutes… :-/ An extra button for indexing/receiving TODOs would be nice since the F4 button lays near some other buttons I use quite often. Yes I could change the settings / keymap but … come on….

  • doerteDev

    Edit since mind is f*****:
    Alt+6 was it, not F4. Still the same problem, Alt+5 is the debugger, Alt+7 is the Structure (useful for large classes) …. :-/

  • Jörg Wrase

    Old Problem is not solved?

    Create an ToDo in an .php – File in html-Code is not listed in the ToDo-Window:

    Some Text

  • Kevin

    How can you exclude a directory (such as vendor)?

  • Darius Motte

    Working with TODO might be enough for small projects in a very small team.
    But I wish there was a feature to create an issue to an external bugtracking system like bugzilla oder youtrack inside the phpstorm ide. BTW. netbeans can do so for years 😉