4 ms·
TODO messages are a terrible taxation on comprehension of code. Most TODO items should be written "TODIDNT", what would we guess, 99% of TODO items never happe
by jquast 10y ago
TODO messages are a terrible taxation on comprehension of code.
Most TODO items should be written "TODIDNT", what would we guess, 99% of TODO items never happen? What is the thinking here, "I knew I should have written the code more correctly, but I didn't -- commenting about what I failed to do here gives me a pass"?
Either do it, or don't. Don't tell everybody about what you didn't do, it reduces comprehension of the code at hand.
I'm a fan of a DESIGN.txt or other document that everyone can bitch and moan about shortcomings into. It's centralized and threaded by contributions, something like a wikimedia Talk page.
- bArray 10y agoHow do you reference a particular bit of code? For example, when you're writing the code you are aware that a number of lines could definitely do with improving but will get you out of the clear for the moment and past the milestone/deliverable. How do you specifically reference the code that you know is bad in this system?
- jquast 10y agoBy naming the file, class, method, or function name, or even variables or values discussed.
- bArray 10y agoDon't you find they get updated, moved or renamed? I personally have to deal with scope creep in my projects, so things often change from a strict design. But I imagine a longer project doing the same?