On: Writing system software: code comments

[p0nce]

Great article. I like "debt comments" though, no point hiding defects really.

[rocqua → p0nce]

It depends on what kind of code you are working on. Having 'debt comments' in production code could be taken as a suggestion that code should not be in production.

What I really like are "This is fine, but with effort it could be done better like this" comments, which one might also call 'debt comments'. For example, if you have a brute-force search on something that could be done by bisection.

[p0nce → rocqua]

Let's rewrite this: there is a point to hiding defects... if you are a contractor or looking for a promotion.

[rocqua → p0nce]

Alternatively, one should address defects by fixing them not just marking them.

[p0nce → rocqua]

You can't address them later if you've forgotten where they are. Maybe there is no time "now".