We recently did a video about making Godot more organized featuring a plugin that handled TODO and FIXME comments automatically. I was asked “What about if I work in Visual Studio Code?” which is probably the most popular code editor today. Therefore we today are going to be looking at two plugins (sadly it required two and not a singular solution like Godot) to enable auto highlighting and indexing of TODO/FIXME/HACK comments within your code.
The first plugin is rather simple, the TODO Highlight plugin simply locates and highlights matching words such as TODO in your code when open in the editor. It is described as:
Highlight
TODO,FIXMEand other annotations within your code.Sometimes you forget to review the TODOs you’ve added while coding before you publish the code to production. So I’ve been wanting an extension for a long time that highlights them and reminds me that there are notes or things not done yet.
Hope this extension helps you as well.
The second plugin is TODO Tree which enables you to quickly find all instances of TODO (and other keywords) across your project. It is described accordingly:
This extension quickly searches (using ripgrep) your workspace for comment tags like TODO and FIXME, and displays them in a tree view in the activity bar. The view can be dragged out of the activity bar into the explorer pane (or anywhere else you would prefer it to be).
Clicking a TODO within the tree will open the file and put the cursor on the line containing the TODO.
Found TODOs can also be highlighted in open files.
Key Links
In the video we show how to use and configure both of these Visual Studio Code TODO plugins to better organize your hacks and various code debts within your project. 😉