How to use comments in jQuery, automate your comments using a plugin and effectively comment witout floading comments use them effectively.

Basic jQuery comments

jQuery comments are started with a double forward slash which tells the interpreter that the following text on the line is not to be processed as JavaScript. jQuery comments can be either inside a function or outside it makes no difference.

function myFunction ( myVar, myVar2 ) {
// Pay attention to spaces around
// the brackets and curly brackets
// some prefere it like this
function myFunction()

Multi-line jQuery comments

Multi-line jQuery comments are enclosed within a combination of a forward slash and an asterisk like so:

/* comment */

jQuery Commenting Guidelines

Here are a couple of pointers for commenting in jQuery:

  1. Long comments should use /* ... */.
  2. Single line comments should always be on their own line and be
    above the line they reference. Additionally there should be an
    extra endline above it. For example:

var some = "stuff";

   // We're going to loop here
   for ( var i = 0; i < 10; i++ ) {}


Sam Deering is a Front-end Web Developer who specialises in JavaScript & jQuery. Sam is driven and passionate about sharing his knowledge to educate others.

Free Guide:

How to Choose the Right Charting Library for Your Application

How do you make sure that the charting library you choose has everything you need? Sign up to receive this detailed guide from FusionCharts, which explores all the factors you need to consider before making the decision.

  • rocker




  • Vijay Vijay


  • hung

    xin chao ban

  • unknown


Special Offer
Free course!

Git into it! Bonus course Introduction to Git is yours when you take up a free 14 day SitePoint Premium trial.