MPLAB® X IDE Action Items

The Action Items feature provides a convenient means to tag comments in your programs for special attention such as a "To Do" or "Fix Me" reminder. All comments that are tagged with one of the words or character patterns from the following table will be added to the Action Items window the next time the file or project is saved. Once a tagged comment is listed in the window, you can double click on it and you will be taken immediately to its source in the editor window.

How to tag a comment for inclusion in the Action Items list

To tag a comment, simply use one of the words or character patterns from the table (or others you add to the list yourself) as the initial text of the comment. For example, to tag a comment with "TODO" you could use the following:
// TODO Your Comment Here

@todo
TODO
FIXME
XXX
PENDING
«««

How to add, edit, or remove Action Items tags

1

From the main menu, select Tools > Options

2

In the window that opens, click on Team.

Team.png
Click image to enlarge.

3

Select the Action Items tab.

ActionItems.png
Click image to enlarge.

4

Use the Add, Edit, and Remove buttons on the right to modify the list to suit your needs.


How to Display the Action Items List

Select from the main menu:
Window > Action Items local--files

The Action Items window should appear as a tab below the editor near the Output tab.

Action Items comments in your code will not be added to the window until you save the project.

ToDo.png
Click image to enlarge.

How to Add an Action Item to the List

1

Somewhere in one of your project's C source files, add a comment that starts like this:

//TODO Your Action Item/Task Here

2

Save the project by clicking on the Save All Main_Save_All.pngicon on the main toolbar. This will force the IDE to parse all of the files. The TODO comment should now appear in the Action Items list.
© 2021 Microchip Technology, Inc.
Notice: ARM and Cortex are the registered trademarks of ARM Limited in the EU and other countries.
Information contained on this site regarding device applications and the like is provided only for your convenience and may be superseded by updates. It is your responsibility to ensure that your application meets with your specifications. MICROCHIP MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WHETHER EXPRESS OR IMPLIED, WRITTEN OR ORAL, STATUTORY OR OTHERWISE, RELATED TO THE INFORMATION, INCLUDING BUT NOT LIMITED TO ITS CONDITION, QUALITY, PERFORMANCE, MERCHANTABILITY OR FITNESS FOR PURPOSE. Microchip disclaims all liability arising from this information and its use. Use of Microchip devices in life support and/or safety applications is entirely at the buyer's risk, and the buyer agrees to defend, indemnify and hold harmless Microchip from any and all damages, claims, suits, or expenses resulting from such use. No licenses are conveyed, implicitly or otherwise, under any Microchip intellectual property rights.