Skip to content

Add content anchors and fix some oversights #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 3, 2014
Merged

Add content anchors and fix some oversights #62

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
849edf9
Add heading, [fix] exchange 'string' for 'variable'
CristinaSolana Feb 21, 2014
26d396e
remove stray example
CristinaSolana Feb 21, 2014
f19e34d
Add in doc TOC
CristinaSolana Feb 21, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 38 additions & 13 deletions manual/en-US/coding-standards/chapters/javascript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,42 @@
## JavaScript

### Contents

1. [Naming Conventions](#naming-conventions)
- [Variables](#naming-conventions-variables)
- [Functions](#naming-conventions-functions)
- [Reserved Words](#naming-conventions-reserved)
2. [Syntax Style](#syntax-style)
- [Indentation](#syntax-indentation)
- [Spacing](#syntax-spacing)
- [Commas](#syntax-commas)
- [Semicolons](#syntax-semicolons)
- [Quotes](#syntax-quotes)
3. [Types](#types)
4. [Functions](#functions)
5. [Conditional Statements](#conditional-statements)
6. [Blocks & Multi-line Statements](#blocks)
7. [Comments](#comments)

<a name="naming-conventions"></a>
## Naming Conventions

Use descriptive words or terse phrases for names.

Variables and Functions should be camel case, starting with a lowercase letter: `likeThis`

### Strings
<a name="naming-conventions-variables"></a>
### Variables

**Use names that describe what the string is:**
**Use names that describe what the variable is:**

`var element = document.getElementById('elementId');`

**Iterators are the exception**

Use i for index in a loop (and subsequent letters when necessary for nested iteration).

<a name="naming-conventions-functions"></a>
### Functions

**Use names that describe what the function does:**
Expand All @@ -23,20 +46,22 @@ function getSomeData() {
// statements
}
```

<a name="naming-conventions-reserved"></a>
### Reserved Words

Do not use reserved words for anything other than their intended use. The list of: [Reserved Words](http://es5.github.io/#x7.6.1)

---

<a name="syntax-style"></a>
## Syntax Style

<a name="syntax-indentation"></a>
### Indentation
- Don't mix tabs and spaces.
- Tabs, 4 spaces


<a name="syntax-spacing"></a>
### Spacing
- No whitespace at the end of line or on blank lines.
- Unary special-character operators (e.g., !, ++) must not have space next to their operand.
Expand Down Expand Up @@ -117,7 +142,7 @@ foo( data, function() {
});
```


<a name="syntax-commas"></a>
### Commas

**Place commas after:**
Expand All @@ -141,7 +166,7 @@ array = [ 'foo', 'bar', ];
array = [ 'foo', 'bar' ];
```


<a name="syntax-semicolons"></a>
### Semicolons

Use them where expected.
Expand All @@ -164,14 +189,15 @@ function foo() {
}
```

<a name="syntax-quotes"></a>
### Quotes

Use ' instead of "


---


<a name="variables"></a>
## Variables

### Avoid Global Variables
Expand Down Expand Up @@ -216,6 +242,7 @@ var foo = 'bar',
baz = 'qux';
```

<a name="types"></a>
## Types

### String
Expand All @@ -233,10 +260,6 @@ var longString = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. ' +
'cursus mauris.';
```

```
var foo = 'bar';
```

### Number

Use `parseInt()` or `parseFloat()` instead of unary plus, for readability.
Expand Down Expand Up @@ -319,6 +342,7 @@ var myArr = [];
myArr.push('foo');
```

<a name="functions"></a>
## Functions

### Chaining Method Calls
Expand All @@ -330,6 +354,7 @@ $('.someElement')
.fadeIn();
```

<a name="conditional-statements"></a>
## Conditional Statements

Use ternary syntax if:
Expand Down Expand Up @@ -389,7 +414,7 @@ Use strict equality operator === so that type is considered in comparison. Using
1 === "1"
```


<a name="blocks"></a>
## Blocks & Multi-line Statements

Use curly braces on blocks that have more than one statement.
Expand All @@ -409,7 +434,7 @@ if ( test ) {
}
```


<a name="comments"></a>
## Comments

**Single Line**
Expand Down