3 ms·
> Adding “TODO” comments is a quick way of making sure you don’t miss anything. Or is it a quick way of making sure you have a codebase littered with TODO comm
by majormajor 10y ago
> Adding “TODO” comments is a quick way of making sure you don’t miss anything.
Or is it a quick way of making sure you have a codebase littered with TODO comments? :D
(Though even there, at least they serve as documentation about what you didn't do initially, so it's more helpful than nothing.)
- mikekchar 10y agoIf it needs to be done, and you are going to do it, then don't pollute the code base with your personal TODOs. I shouldn't see it, because it should be done by the time I get to it. If you want to put it in the code base, at least put your name in the TODO, so I know who to contact and remind that something was missed. If there is something that needs to be done and you are not going to do it -- the code is the worst place to put it. Basically, what you are saying is that you have a design in mind and want someone else to finish it. If you really can't trust your coworkers to refactor the code and build good designs on their own, use a different communication mechanism. The better thing is to forget about your long term plans, leave the code as simple as you can and trust your coworkers.