WebStorm 2017.3 Help

TODO Example

Consider the following example: creating and viewing TODO items for each of the team members.

Creating patterns for TODO items

On the TODO page of the Settings dialog, click new in the Patterns section, and create additional TODO patterns, for example, todo-John, todo-Bob and todo-me, with new icons, and custom color schemes:


Creating filters

Next, create several filters, which you will use to show the TODO items, say, for each of the developers, and not for your good self. For this purpose, in the Filters section, click new, and specify the filter names, for example, For John, For Bob, and not for me. Associate these filters with the patterns:


Creating TODO items in source code

Now, in the source code, create TODO items: in the line of code, where you want to add a note, press Ctrl+/, or Ctrl+Shift+/, and type TODO that matches one of the patterns, followed by some meaningful description:


Viewing TODO items

Having produced a number of TODO items across the whole project, review them in the TODO tool window: click the TODO button on the tool window bar to show the tool window. By default, all the encountered TODO items are displayed.

Let's now show the TODO items for Bob and John, and hide the other items: click the filter icon filter on the toolbar of the TODO tool window, and select Not for me in the menu:

Last modified: 26 March 2018

See Also