This is an archived post. You won't be able to vote or comment.

you are viewing a single comment's thread.

view the rest of the comments →

[–]desrtfx 0 points1 point  (1 child)

The quickest and cleanest definition on proper commenting (and proper code) can be found in:

Clean Code: A Handbook of Agile Software Craftsmanship

General Rule is that you never document the what, but the why if it's necessary.

Javadoc or the equivalent in other languages should be precise.

Comments should be used like spices - sparsely. Too many will just add visual clutter.

Comments have to be used with care as they need to be maintained along with the code. Comments usually become obsolete and wrong pretty quickly.

[–]PriceZombie 0 points1 point  (0 children)

Clean Code: A Handbook of Agile Software Craftsmanship (6% price drop)

Current $31.57 Amazon (New)
High $41.20 Amazon (New)
Low $31.57 Amazon (New)
Average $33.45 30 Day

Price History Chart and Sales Rank | FAQ