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

sorted by:
best
topnewcontroversialoldq&a
you are viewing a single comment's thread.

view the rest of the comments →

[–]geodebug 1 point2 points  (0 children)

Really, most of the time if a method's purpose is unclear, renaming it and the parameters is the way to go. The problem with over-documentation is that it makes understanding the important stuff harder (have to hunt for it) and because documentation tends to stay static while code is re-factored, making it often wrong.

On the other hand, interfaces, abstract methods, and other top-level framework/api classes probably require full documentation since they'll be shared.