Giters

elsewhencode / project-guidelines

A set of best practices for JavaScript projects

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

A good way to do `//TODO` and `//FIXME`

vpanjganj opened this issue · comments

commented

In section 7 it says:

Always use //TODO: comments to remind yourself and others about an unfinished job.

Some developers avoid // TODO and prefer to open a ticket for any single reminder. This is to prevent TODOs from piling up in the source code.
I personally use a combination of them and I use // TODO mostly to remind myself if there is a need for refactoring.

I think the best approach is using //TODO(#3456) where the number is a ticket and it's enforced by a lint rule. Should we add a sub-section for this? any thoughts/suggestions?