Upgrade StorageDifferences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
| dev:client_coding:coding_guidelines [2014/04/23 17:03] – [Comments] lowercase @param types dstillman | dev:client_coding:coding_guidelines [2014/04/23 17:05] – [Braces] dstillman | ||
|---|---|---|---|
| Line 38: | Line 38: | ||
| </ | </ | ||
| - | Braces must **always** be used, even if the enclosed block contains a single line. | + | Braces must **always** be used for multi-line conditionals, even if the enclosed block contains a single line. |
| Bad: | Bad: | ||
| Line 100: | Line 100: | ||
| ===== Comments ===== | ===== Comments ===== | ||
| - | * Functions should be commented using JSDoc syntax: | + | Functions should be commented using JSDoc syntax: |
| <code javascript> | <code javascript> | ||
| /** | /** | ||
| Line 113: | Line 114: | ||
| } | } | ||
| </ | </ | ||
| - | * For readability and neatness, add a space after the slashes in line comments, and capitalize the first word: | + | |
| + | |||
| + | For readability and neatness, add a space after the slashes in line comments, and capitalize the first word: | ||
| Bad: | Bad: | ||
| <code javascript> | <code javascript> | ||