179

What are the established coding standards for JavaScript?

Improve this question
8
  • 1
    Seeing this question still shows up in google search I thought adding this might be relevant. JavaScript is an implementation of ECMAScript script, following the ECMA standards. Standard ECMA-262. To add from the ECMA wiki page: Netscape delivered JavaScript to Ecma International for standardization and the work on the specification, ECMA-262, began in November 1996 Commented Oct 22, 2013 at 9:11
  • 13
    Closed AND protected. Huh!?! Commented Oct 29, 2013 at 12:49
  • 1
    sourceformat.com/pdf/javascript-coding-standard-apple.pdf Commented Sep 11, 2014 at 7:52
  • 13
    // , WHHHHYYYY was this closed? It's an excellent question for new Javascript programmers. Especially given the, ah, state of most original Javascript code written by new programmers. Commented Jun 11, 2015 at 5:10
  • 1
    This is VERY constructive, and an excellent fit for the SE Q&A format. Commented Jul 12, 2016 at 4:09

8 Answers 8

Reset to default
75

Not exactly what you're looking for, but (like Doug Crockford's vids) I think everybody who writes/edits/reviews JS should look at Chris Heilmann's slides and videos on maintainable javascript.

In the slides, slide 127, he says don't worry so much about style guides/code standards, reformat all code checked in to VCS.

Also these:

Mozilla JavaScript Tips

JavaScript Style Guide

Improve this answer
Sign up to request clarification or add additional context in comments.

4 Comments

Google also has a style guide: google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml
In an attempt to solve this question (finding and deciding on a JavaScript Code Style, while allowing for some flexibility), I've created jscode.org where you can generate custom code styles according to some settings (yeah, it may sound like blatant advertising, but I'm not gaining anything there, I just built this for myself and my team, and I think it's of good value).
The Mozilla JavaScript Tips is very sparse, I wouldn't include it.
All the links broken. this is an example of a BAD Answer
24

Another reason why Crockford's JavaScript coding guidelines are a good idea to follow:

This code (below) actually returns undefined because of JavaScript's semicolon injection - which is a damn good reason to get the whole team of developers singing from the same song sheet:

return // injected semicolon, therefore returns 'undefined'
{
    javascript : "fantastic"
}; // object constructs anonymously but nothing happens with it.

Bit more about that at Beware of JavaScript semicolon insertion

Improve this answer

1 Comment

There is also JSLint to help automate/verify some of these guidelines. jslint.com
10

I never saw a widely acknowledged JavaScript coding standard out there. We did write our own some time ago and I published it on my blog in accordance with my employer.

Keep in mind that some of the guidelines might be a bit outdated.

Improve this answer

1 Comment

This document has reference to 'C# programming guidelines'. Do you have it publicly available as well?
8

Google has posted a Javascript guide

Improve this answer

1 Comment

This is a "link only" answer and the link does not work anymore which is exactly why "link only answers" should be avoided.
6

You can find some simple but essential coding conventions at the Google Code Wiki.

For very detailed style guides read the Dojo Style Guide. It is going over naming conventions, file conventions, variable usage, code layout, whitespace, and comments.

Improve this answer

Comments

4

A bit puzzled that I cannot find on the replies Idiomatic.js and jQuery Core Style Guide. Addy Osmani puts those two on the very top of full list of coding styles for JavaScript in his "JavaScript Style Guides And Beautifiers" article.

I personally prefer jQuery standard, though it doesn't much differ from Idiomatic.js. But whatever standard you choose you will need a validator to check how successful you are following it. I couldn't find any for jQuery or at least Idiomatic, but eventually came up with JS_CodeSniffer

Improve this answer

Comments

3

The comp.lang.javascript Code Guidelines document points to causes of errors and problems related to javascript for web applications and how to avoid them.

Improve this answer

Comments

2

Myself and a few others recently put together these (PDF or HTML)

They are primarily intended for use with the Ajax Control Toolkit but realistically contain all sorts of useful guidance whichever framework you use.

Hope that helps.

Improve this answer

Comments

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.