3 ms·
You have almost converted me from using TODO. I typically place a "Note:" when there's code that is hacky but not obviously so, to provide context. I also make
by IggleSniggle 7y ago
You have almost converted me from using TODO. I typically place a "Note:" when there's code that is hacky but not obviously so, to provide context. I also make sure to provide a link if some kind to a relevant issue tracker.
But a TODO is something different. It's for prototype code, where I don't even know if the feature is going to stick around long enough for the hack to warrant fixing. It says "don't worry about just deleting this whole thing outright and starting fresh." It's graffiti to intentionally make the code uglier, so it's not confused for being part of some larger design. It says, "hey, so, I didn't actually expect this code to survive, but since you're here reading this, it clearly did, you're probably working on something related to it, and you might want to know a few things upfront because it's not going to go the way you think it should go."
- sedatk 7y ago"Note:" comments are perfectly fine. On the other hand, I've seen at least three distinct definitions for TODO in this HN thread: - TODO should be a note about behavior. - TODO should prescribe a small fix. and yours: TODO should mean "don't worry about deleting this". These different interpretations and potential confusion they would create make even a stronger argument against TODOs.
- IggleSniggle 7y agoI'm afraid "don't worry about deleting this" was poorly phrased...but your point still stands