3 ms·
Replace the not-TODOs with NOTEs. For example, this TODO: //todo: factor this out in case X …is a NOTE, albeit a gratuitous one. Because if X ever happen
by owlstuffing 1y ago
Replace the not-TODOs with NOTEs.
For example, this TODO:
//todo: factor this out in case X
…is a NOTE, albeit a gratuitous one.
Because if X ever happens, the note won’t matter anyway, since you will have had to grok all the related code to refactor. You will see this note while you’re refactoring the surrounding code and smirk, “yep, that’s right”, or “no, it doesn’t really fall out that way.” Either way, most TODOs/NOTEs like this just get in the way.
- zahlman 1y agoTo me, "NOTE" still implies that the comment is about describing the existing state, rather than a desired future state.