Quote:
Originally Posted by kermitology
As nice as self documenting code is, it still lacks the complete clarity of inline comments. You don't have to document every single line, but if there is any decision being made, something that might be in any way unclear, tell someone about it.
I once read a quote that said something along the lines of: "Document your code as if the next guy who has to support what you've written is a homicidal maniac, and he knows where you live"
|
+1 for documenting your code.
That homicidal maniac may just in fact be you 6 months from now. I hate going back to something I've written in a rush and didn't document properly and trying to figure out exactly how it worked while thinking "there's no way I could have written something this sloppy".