TODO to do what to do
We can put what to do directly in codebase with TODO comments
There are tons of works and we have to update our codebase here and there. How to communicate with team members what and where shall we have to do?
No more list in paper nor tickets. We can put what to do directly in codebase with TODO comments.
TODO comments
TODO comments are literally comments with a keyword to marking TODO items. Just creating a comment and starting with TODO keyword to make a TODO comment. They aren’t limited to what TODO but also TOFIX and much more. However, the common keyword are TODO, BUG, and FIXME.
Most modern IDEs have integrated or have plugins in their extension market for TODO comments.
Examples
I usually work on VSCode and Neovim so we can see how to write TODO comments in them. Other IDEs should have the same way.
VSCode
For example, Visual Studio Code has “todo-tree” plugin.
When the plugin installed completely, we can see the tree-like icon in the menu bar and click it to see the “tree” of all scannable TODO comments. Like this.
And when we click on any TODO, it will open the file and jump to that lin immediately.
Neovim
There is a plugin for TODO comments in NEovim that I usually use it and it is shipped with Lazyvim.
We can type by default space+s+t to open Grep window showing TODO comments as the figure below.
