4 ms·
For all the folks saying the comment itself is bad... Please explain why? All i can think is that adding a date and author might be nice so the current maintain
by amichal 11y ago
For all the folks saying the comment itself is bad... Please explain why? All i can think is that adding a date and author might be nice so the current maintainers can give some thought to if we care about those old subtle bugs x decades later without digging through 3+ changes (guess) to version control systems.
- pyre 11y agoWell, the other question is does it even need to be in the code? Could there be a documentation / spec file somewhere that uses this code as the reference implementation, and just add a comment that says "see spec file" next to the code?
- pbalau 11y agoAfter 15+ years writing software, I can guarantee you that keeping 2 files in sync (eg the source file linked to the spec file) for more than foo days is not going to happen.
- lmm 11y agoTrying to use this to catch subtle bugs is the worst kind of "the implementation is the spec". If you can't document what it does except in executable code, you don't understand what it does, and you need to go back to requirements gathering and then write some tests for the important cases. Or, better still, write the actual code in a way that's readable and expresses the intent.