JavaScript Style and jQuery Best Practices

Table of Contents

1. Symbols

1.2. Required blocks

http://jslint.com/lint.html This is a jslint recommendation to enclose

2. Documentation

3. Framework (jQuery)

4. Files

4.4. Load scripts late   files crockford performance

Late in the body as possible

5. Naming conventions

6. Grammar

6.1. Indentation: 4 spaces   style crockford

correct · pilot-annotation-pass · 2026-10-08

Audit: untabify.

6.2. Line Length: 80 characters   style crockford

needs-citation · pilot-annotation-pass · 2026-10-08

6.5. Required blocks: true   jslint

if (condition) { statements; }

7. Operators

8. Objects

8.2. Function Declarations   crockford rashbrook

rashbrook: Name inline functions This might not be a best practice, doesn't appear to be used: observe: function offlineObserve(aSubject, aTopic, aState)

8.3. Names   crockford

Disallow leading _ in identifiers

8.5. Don't pollute the global namespace

Play well with others (Namespacing, scope and patterns) in http://icant.co.uk/articles/seven-rules-of-unobtrusive-javascript/

http://developer.apple.com/documentation/ScriptingAutomation/Conceptual/JSCodingGuide/Advanced/Advanced.html#//apple_ref/doc/uid/TP40006541-SW1

recommends:

Use the var keyword. Any variable created without the var keyword is created at the global scope and is never eligible for garbage collection, presenting the opportunity for a memory leak.

Use a global array, global object, or namespace prefix. If you need global variables, use a global object that contains all of the global variables, like this

8.6. Newlines follow anonymous functions with jQuery   style

Split any method calls that invoke anonymous foundtions. This should be done to reduce the amount of extra whitespace but makes the scripts longer

8.7. jQuery variables   style

corrected · pilot-annotation-pass · 2026-10-08

If a jQuery object is returned should a "$" prefix be used?

http://dotnetslackers.com/articles/ajax/JQuery-Primer-Part-1.aspx

This is commonly used in practice; the claim that it violates ECMA 262 is incorrect – "\(" is an explicitly valid identifier character, as jQuery's own global "\)" demonstrates.

8.8. Disallow = and !   jslint

verified · pilot-annotation-pass · 2026-10-08

8.9. Cache function pointers   performance

For iterating through DOM elements initialize the variable:

styles = getElementsByClassName("script); for (var i = 0; i < styles.length; i++) { console.log(styles[i]); }

http://blogs.msdn.com/ie/archive/2006/08/28/728654.aspx

9. Related