Hacker News new | ask | show | jobs
by cjdentra 5061 days ago
Synchronization to source and perhaps being able to detect when comments are not current would be a great feature. How about associating comments to code but outside of it sort of like a "source-aware" wiki?
2 comments

That idea kind of reminds me of the annotated source used for backbone. http://backbonejs.org/docs/backbone.html
I love the philosophy behind the annotated source for backbone. But, there seems to be something more going on with commenting - especially given that the content of the backbonejs.org homepage is different from that of the annotated source.

I guess the comments are meeting the needs of two different audiences (those looking at just the api and those looking ay the code).

Hmmm... this would be great especially for cases where you have documentation that applies to multiple methods or classes.

Ofcourse, the devil is in the details of getting it right.