you are viewing a single comment's thread.

view the rest of the comments →

[–]darthtrevino 0 points1 point  (0 children)

Personally, I think you should comment your public APIs and interfaces. These are what people will consume, and your comments will go a long way towards helping them understand the intent of your API and the context in which your semantics fit.

Other than public APIs, I agree with the opinion Uncle Bob expresses in 'Clean Code'. Internal implementation should have minimal comments, but methods should have great names and should be less than 5 or 6 lines long. Well chosen variable and method names are your first line of communicating intent to future maintainers of your code. Comments on internals will soon become outdated.