Giter VIP home page Giter VIP logo

jquery-annotated-source's Introduction

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.

jquery-annotated-source's People

Contributors

robflaherty avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.