Menu
I have seen the other questions but I am still not satisfied with the way this subject is covered.
I would like to extract a distiled list of things to check on comments at a code inspection.
I am sure people will say things that will just cancel each other. But hey, maybe we can build a list for each camp. For those who don't comment at all the list will just be very short :)
778
Commenting involves placing Human Readable Descriptions inside of computer programs detailing what the Code is doing. Proper use of commenting can make code maintenance much easier, as well as helping make finding bugs faster. Further, commenting is very important when writing functions that other people will use.
Common reasons that people cite for not writing comments include: Good code should be self-documenting. If you can't understand the code from reading it, then the code's not good and should be rewritten.
Documentation is like sex; when it's good, it's very, very good, and when it's bad, it's better than nothing
75
The only guaranteed place I leave comments: TODO sections. The best place to keep track of things that need reworking is right there in the code.
20
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
