3 ms·
Not if the system fails on a Monday morning at 3am after 20 years without issues and needs to be fixed before the business opens. Having comments for every line
by dx034 9y ago
Not if the system fails on a Monday morning at 3am after 20 years without issues and needs to be fixed before the business opens. Having comments for every line helps fixing it dramatically.
For most code it will be overkill but there are some companies where it's integral for core systems.
- methyl 9y ago> Having comments for every line helps fixing it dramatically. That’s only true if comments are kept up-to-date. More often than not, they get out of sync with the code itself, causing even more confusion.
- Pamar 9y agoHonestly, these kind of problems are often due to unplanned/unexpected events (disk full, wrong permissions on a folder, OS updates correcting old bugs you have coded around) where having line-by-line comments would not help much if at all. I would love to work in a place where documentation was cosidered a valuable asset, but I think that your example is off mark.
- hellofunk 9y agoSure but every line? You increment a loop counter, i+=1; and you say that in a comment? The best rule of thumb is, make the code so clear that it is itself a comment, and only if the code cannot relay the meaning, then add a comment.
- injvstice 9y agoDepending on the code, it can be freaking hard to track down what that 'i' means, especially when someone writes a coding standard (or a language) where it requires all variables to be defined at the beginning of the function instead of close to location of use. on the other hand, if it was named something like number_of_records it would be clearer.