Scanning for TODOs in Source Code
See Also
The To Do window scans your code and lists all TODO tasks. By default, the
IDE recognizes all of the following as TODO tasks:
- Javadoc comments that contain the @todo keyword
- Comments that contain the TODO, XXX, or FIXME keywords
- Comments that contain any custom keywords you have registered with the Task List
- You can register custom task keywords and set
the priority for each type of task keyword. Choose Tools >
Options from the main window and click Advanced Options in the Options window.
In the left pane, expand the Editing node and select To Do
Settings, and open the property editor for Task Tags in the property sheet in the right pane.
To open the To Do window:
- Choose Window > To Do from the main window (Ctrl + 6).
The To Do window opens at the bottom of the IDE. You can scan:
- Current File. Scan the selected file in the Source Editor. The To
Do window scans each file as you open it in the Source Editor.
- Opened Files. Scan all the files that are currently open.
- Selected Folder. Specify a folder to scan for TODO tasks.
You have to refresh the list manually using the Refresh button (
).
- To filter the TODO tasks displayed, select a filter from the filter drop-down list.
You can modify existing filters and create your own To Do task filters.
To create and modify To Do task filters:
- Click the Edit Filter button (
) in the toolbar to open the Edit Filter dialog box.
- Do one of the following:
- To create a new filter, click New and enter a name for the filter.
- To modify an existing filter, select the filter in the Filters pane.
- Specify the filter conditions. Use the More and Fewer buttons to add or remove conditions for the filter.
- Click Preview to see the results when the filter is applied to the current list of To Do tasks in the To Do window.
- Click OK.
To jump to a TODO task in the Source Editor:
To specify what information is listed for each task:
- Click the columns button (
)
in the top right corner of the Task List window.
- Check the checkbox for each type of information you want to be listed.
- See Also
- Configuring the Source Editor
- Setting Keyboard Shortcuts
Legal Notices