Drupal 6 JavaScript and jQuery - Ebook-Cours.com

[ 35 ]
Chapter 2
• Indenting should be done with two spaces (and no tabs). This keeps the code
compact, but still clear.
•
Comments should be used wherever necessary.
° Doxygen-style documentation blocks ( /** ... */) should be
used to comment files and functions.
°
°
Any complex or potentially confusing code should be
commented with // or /* ... */.
Comments should be written in sentences with punctuation.
• Control structure keywords ( if, else, for, switch, and so on) should appear
at the beginning of a line, and be followed by a single space (if (), not
if()). Here's an example:
if (a) {
}
// Put code here.
else if (b) {
}
// Put code here.
else {
}
// Put code here.
• Operators ( +, =, *, &&, ||, and so on) should have a single space on each side,
for example: 1 + 2. The exception to this rule is the member operator (.),
which is used to access a property of an object. There should be no spaces
surrounding these. Example: window.document (never window . document).
Stylistic differences between PHP and JavaScript
Not all PHP coding standards apply to JavaScript. PHP variables and function names
are declared in all lower case with underscores (_) to separate words. JavaScript
typically follows different conventions.
JavaScript variables and functions are named using camel case (sometimes called
StudlyCaps). For a variable or function, the first word is all lower case. Any
subsequent words in the variable or function name are capitalized. Underscores
are not used to separate words. Here are some examples:
var myNewVariable = "Hello World";
function helloWorld() {
alert(myNewVariable);
}
This material is copyright and is licensed for the sole use by Richard Ostheimer on 18th June 2009
2205 hilda ave., , missoula, , 59801