Highlighting comments containing TODO in Sublime Text 2

Question

Is there a way to tell Sublime to highlight comments that contain the word "TODO"?

I've looked for plugins that do this but haven't really been able to find much.

Sublime text puts a box around matches for the current selection, so you can just select the text TODO anywhere, and the rest will be highlighted. — Antimony, Apr 28 '13 at 02:08

score 36 · Answer 1 · edited Oct 30 '17 at 19:56

36

Sublime Linter should do the trick. You can add underlining for custom static text.

All you need is the Sublime Package Manager:

Press Ctrl/Cmd+Shift+P
Search for "Package Control: Install Package"
Search for "SublimeLinter"

As stated by jon in the first comment:

For ST3, the SublimeLinter-annotations plugin highlights TODO, FIXME etc.

edited Oct 30 '17 at 19:56

Ilario Pierbattista

3,175
2
31
41

answered Oct 29 '13 at 20:34

jstaab

3,449
1
27
40

29

For ST3, the [SublimeLinter-annotations](https://github.com/SublimeLinter/SublimeLinter-annotations) plugin highlights TODO, FIXME etc. – jon Oct 22 '14 at 10:35
2

For ST2, do "Preferences" -> "Package Settings" -> "SublimeLinter" -> "Settings-default", set "sublimelinter_notes" to true – vpekar Aug 11 '15 at 05:57
1

I cannot find out how to do this inside of Sublime Linter. I read through the settings and through their readme page (I could not find more documentation on this plugin) I did not see any static highlighting in the current settings. Could you (or someone) show where this is done in this plugin? – Steven Rogers May 17 '16 at 17:29
3

I also installed SublimeLinter-annotations and that did just what I wanted and worked like a charm! It did however require SublimeLinter as a prereq of course. – Jared Jun 16 '16 at 07:05

score 9 · Answer 2 · edited Feb 03 '16 at 19:07

9

I'm using the TodoReview plugin. It's very good and simple.

After installing it via Package Control, in order to use it on Windows, press Ctrl+Shift+p and type TodoReview: Project Files.

It will open up a tab with all TODOs in your project, where you can navigate with up/down and go to the TODOs location with enter.

edited Feb 03 '16 at 19:07

the Tin Man

158,662
42
215
303

answered Mar 27 '14 at 10:49

Fabricio

7,705
9
52
87

This didn't work for me. when I go to TodoReview: Project Files nothing happend, and I tried many combinations of writing TODO comments. I am on win8 – Mladen Janjetovic Aug 07 '14 at 10:02
@MladenJanjetović are u using sublime3? It works for me. – Fabricio Aug 07 '14 at 12:12
@@Fabricio - No, Sublime Text 2 – Mladen Janjetovic Aug 07 '14 at 14:58
2

@MladenJanjetović thats why then. Its for sub3 – Fabricio Aug 07 '14 at 15:42
@Fabricio It doesn't work for me. I use sublime text3. – damo Aug 10 '14 at 07:00
@damo not my fault lol. It works for me. Contact devs if u wish. I liked it a lot. – Fabricio Aug 10 '14 at 14:20
@Fabricio Sorry about that comment, but it working for me now :) – damo Aug 11 '14 at 22:24
@MladenJanjetović it claims to work in ST2 also... Perhaps there's something else wrong? Did restarting ST help? – drevicko Nov 11 '14 at 01:05
1

@MladenJanjetović another thought: did you include a colon in the TODO comment. eg: `#TODO : blah blah` - the regex used to find TODO's insists on the colon being present, possibly preceded by spaces. You can also change the regex to your liking.. – drevicko Nov 11 '14 at 01:54
@drevicko - restart is the first thing I tried and it didn't help. And when I wrote like you suggest, it just freeze the whole ST for the first time. And then again after few minutes it pop up with todo list :) – Mladen Janjetovic Nov 11 '14 at 17:41
@drevicko removing the colon in the plugin's settings did the trick, thanks! – Radu Jul 29 '16 at 06:27

score 3 · Answer 3 · answered Apr 28 '13 at 02:15

3

Try this plugin : https://github.com/robcowie/SublimeTODO Maybe it can meet your requirement.

answered Apr 28 '13 at 02:15

Chris Li

3,715
3
29
31

3

it searches for all TODO comments and displays them in a separate tab = nice, but it does not highlight them in the "edit" mode, like Vim does... – webwesen May 13 '13 at 15:19

score 2 · Answer 4 · answered Jun 17 '13 at 15:22

The "highlight_code_remarks.py" plugin seems to do what you are looking for. It can be found on: https://bitbucket.org/theblacklion/sublime_plugins/src/

It requires some handwork to install, especially note that:

You don't just need to copy the highlight_code_remarks.py file, but also the entire "support" folder.
Read the Instructions on the beginning of highlight_code_remarks.py file. If you just want keyword highlighting, you may skip the part which explains how to install the key bindings.

In case of trouble also have a look at this forum post, that's where I originally found the plugin: http://www.sublimetext.com/forum/viewtopic.php?f=5&t=1745

...and just in case someone reading this has never installed a sublime plugin before: In Sublime Text, click "Preferences", then "Browse Packages..."

Copy the files mentioned above belong to your "User" subfolder.
The color scheme configuration files can be found in the "Color Scheme - Default" subfolder.

score 1 · Answer 5 · answered Mar 22 '19 at 12:35

1

Try the HighlightWordsPlugin. Worked great for me on Sublime Text 3

answered Mar 22 '19 at 12:35

andrewcockerham

2,676
3
23
19

Highlighting comments containing TODO in Sublime Text 2

5 Answers5