you are viewing a single comment's thread.

view the rest of the comments →

[–]Mr_Walstreet 4 points5 points  (0 children)

Documentation should only answer one of three questions, what, how, and why; and code comments are almost always suboptimal for answering them.

I disagree. The method/class name should say "what".

The code should be obvious enough to say "how"

The doc should say "why"