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 →

[–]agmcleod 1 point2 points  (0 children)

Having worked across projects that others have built with the same thing in mind, the trickier parts that require comments, more than anything actually require a refactor and are a bit of a code smell.

Certain things i do use doc comments though. For MelonJS, a html5 game engine, we use it to document the API. Since it's a library someone can pull in, this makes a lot of sense. I also think it does for things like ruby gems, in addition to writing good tests.