TODO Tool Window
PhpStorm scans your project for comments in the source code that match the TODO patterns defined in the TODO dialog and displays results in the TODO tool window.
The TODO tool window consists of following tabs:
- Project tab that show the TODO items for the whole project.
- Current File tab.
- Scope Based tab that enables viewing TODO items pertaining to a certain scope, selected from the drop-down list, and ignoring the other items.
- Current Changelist, if version control is enabled.
This tool window helps you view, sort and group the TODO items in a convenient way, navigate to the source code and keep fixes under the version control.
On this page:
|Item||Tooltip and shortcut||Description|
|Navigate to the previous TODO item.|
|Navigate to the next TODO item.|
|Use this icon or shortcut to open the corresponding help page.|
|Use these buttons to have all nodes expanded or collapsed.|
|Autoscroll to Source||Toggle the Autoscroll to source mode. When this button is pressed, every time the node is focused, the corresponding line of source code is highlighted in the editor.|
|Filter TODO items||Click this button to select the desired filter from the list, or invoke the
and edit the list of TODO patterns and filters as required.|
|Preview Usages||If this button is pressed, a pane to the right shows the source code of the selected file, with the corresponding TODO item highlighted.|
|Ctrl+D||If this button is pressed, the TODO items show under the corresponding module or library node.|
|Ctrl+P||If this button is pressed, the TODO items show under the corresponding packages.|
|Ctrl+F||If this button is pressed, the TODO items show as a flat list. Thus, if a package is somewhere deep within your project, you do not need to dig deep into the hierarchy.|
Context menu commands
|Jump to Source||F4||Navigate to the selected usage in the source code.|
|Local History||Show Local History submenu for the selected search result. Refer to the Local Version Control procedures for details.|
|<VCS>||Show menu of the VCS, associated with the directory. See Version Control Procedures and Reference for details.|
Title bar context menu and buttons
The title bar context menu provides the options for controlling the tool window viewing modes. It also contains the commands for associating the tool window with a different tool window bar, resizing and hiding the tool window.
To access the menu, right-click the window title bar.
Note that most of the menu options may alternatively be accessed by means of the title bar buttons.
|Toolbar icon||Context menu command||Description|
|Pinned, Docked, Floating, Split Mode||These options let you control general appearance and behavior of the tool window, see Viewing Modes.|
|Move to||To associate the tool window with a different tool window bar, select this command, and then select the destination tool window bar (Top, Left, Bottom or Right).|
|Resize||To resize the tool window by moving one of its borders, select this command,
and then select the necessary Stretch to option.
Note that this command is not available in the floating mode.
|Hide||Use this command to hide the tool window.|