A note on TODO comments

When writing TODO comments and working with other people (or even alone just to build good habits), I would advise putting your name/initials in as well as the date the comment was made and the reason (or actual TODO task). This will make it easier to figure out who left which TODO, when they did it, and why it was made.

For example, my TODO snippet for work is // TODO - jarthur - dd/mm/yy - Reason for comment

Now if I ever need to see what I have left in my TODO list, I can either just do a Ctrl + Shift + F and look for “TODO - jarthur” or filter through the task list and look for “jarthur” which makes life easy when some comments are there for months before being addressed. This will be especially helpful in bigger teams or on projects with thousands of files.

2 Likes

Privacy & Terms