jQuery Annotated Source
JavaScript CSS

readme.md

jQuery Annotated Source

Please Note: This project was released in 2011 when 1.6.2 was the latest jQuery version. It is no longer maintained.

Jumping in to the source code of a popular library and seeing how the sausage is made is a great way to level-up on your journey to JavaScript badassery. But reading through 10K lines of highly refined code can be a daunting task.

One solution is an "annotated source" (seen in libraries like Underscore.js and Backbone.js), which makes source code much more accessible by making the accompanying comments easier to read.

Wouldn't it be nice if we had an annotated source for jQuery? Thanks to @jashkenas's Docco tool, creating annotated source documentation is easy peasy lemon squeezy.

I've gotten things started. If you're a jQuery nerd that knows the jQuery internals well and would like to help out, please fork and submit pull requests with your edits. The goal is to add documentation where comments are missing and replace terse comments with more readable, more natural language.

You can check it out here.

Questions/Comments? Hit up the Issues tab or find me on the Twitters at @robflaherty.