JQuery Annotated Source

This is an old version of jQuery run through docco, with a simple page on top of the docco output.<p>docco: <a href="http://jashkenas.github.io/docco/" rel="nofollow">http://jashkenas.github.io/docco/</a><p>I just checked out jquery and built it myself. Here's a newer version:<p><a href="http://shalecraig.com/docs/manipulation.html" rel="nofollow">http://shalecraig.com/docs/manipulation.html</a>

Is it strange that I found myself mostly ignoring the comments when I was trying to understand this?<p>The only thing I found the comments useful for understanding was pointing out the IE compatibility behavior.

Hey, this is pretty cool.<p>Does this style of annotation exist for any other libraries/projects?<p>I think the left side could be expanded into a pretty good pedagogical tool using mini-examples and explanations to focus on key concepts in the code.

Looking through jQuery's test suite provides alot of insight also<p><a href="https://github.com/jquery/jquery/blob/master/test/unit/core.js" rel="nofollow">https://github.com/jquery/jquery/blob/master/test/unit/core....</a>

Here's a different approach: <a href="http://www.keyframesandcode.com/resources/javascript/deconstructed/jquery/" rel="nofollow">http://www.keyframesandcode.com/resources/javascript/deconst...</a>

i actually find docco-style docs more difficult to read with mostly single-line notes due to the spacing :(<p>some sort of block folding would help a lot to follow code progression like a story. i'm not certain this is the best display type for all commenting styles.

If anyone is interested in generating this type of documentation but for larger projects you might want to check out Groc<p><a href="https://github.com/nevir/groc" rel="nofollow">https://github.com/nevir/groc</a><p>It handles multiple languages and keeps your document structure in the navigation.

I absolutely love this.<p>I would love to see a project (a curated version) like this for Rails.

This is great.