summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorwolfbeast <mcwerewolf@wolfbeast.com>2020-03-06 23:23:57 +0100
committerwolfbeast <mcwerewolf@wolfbeast.com>2020-04-14 13:03:34 +0200
commit94494805dae5641fcb7be821e144a6828178f435 (patch)
tree4d814c657d2973cdfd1b28fd63c16cde220e9fbf /docs
parent5c7109182c5cbc6b3fa187b58ad9d1b5daeba23e (diff)
downloadUXP-94494805dae5641fcb7be821e144a6828178f435.tar
UXP-94494805dae5641fcb7be821e144a6828178f435.tar.gz
UXP-94494805dae5641fcb7be821e144a6828178f435.tar.lz
UXP-94494805dae5641fcb7be821e144a6828178f435.tar.xz
UXP-94494805dae5641fcb7be821e144a6828178f435.zip
Update UXP coding style guide JS guide.
Diffstat (limited to 'docs')
-rw-r--r--docs/UXP Coding Style.md19
1 files changed, 13 insertions, 6 deletions
diff --git a/docs/UXP Coding Style.md b/docs/UXP Coding Style.md
index 1a8c6bb36..c18e5a277 100644
--- a/docs/UXP Coding Style.md
+++ b/docs/UXP Coding Style.md
@@ -273,8 +273,8 @@ Applies to `*.js` and `*.jsm`.
}
}, false);
```
--
--
+- Use a single space between `{` `}` braces in empty js objects.
+
### Flow control
Flow control expressions should follow the following guidelines:
- Scopes have their opening braces on the expression line
@@ -282,6 +282,7 @@ Flow control expressions should follow the following guidelines:
- Any alternative flow control paths are generally started with an expression on the closing brace line. The logic behind this is that you should keep the flow control level visually the same for the executed code blocks with no breaks (a closing brace on its own line means "done").
- Case statements are indented by 2 on a new line with the case expression on its own line.
- Flow control default scopes are always placed at the bottom.
+
#### if..else
`if..else` statements example:
```JavaScript
@@ -357,7 +358,6 @@ switch (variable) {
```
#### try..catch
- When using `try..catch` blocks, the use of optional catch binding is discouraged. Please always include the error variable.
-- Use a single space between `{` `}` braces in empty code blocks.
`try..catch` flow control examples:
```JavaScript
@@ -371,7 +371,8 @@ try {
try {
do_something();
-} catch(e) { }
+} catch(e) {
+}
try {
do_something();
@@ -387,6 +388,11 @@ try {
// No error processing
do_something_else();
}
+
+// No closing brace on its own line
+try {
+ do_something();
+} catch(ex) { }
```
### Long line wrapping
@@ -423,11 +429,12 @@ somelongvariable = somelongexpression ?
Cu.import("resource:///modules/DownloadsCommon.jsm", {})
.DownloadsCommon.initializeAllDataLinks();
+
+let sessionStartup = Cc["@mozilla.org/browser/sessionstartup;1"]
+ .getService(Ci.nsISessionStartup);
```
## XUL and other XML-derivatives
Applies to `*.xul`, `*.html`, `*.xhtml`.
## IDL
Applies to `*.idl`, `*.xpidl` and `*.webidl`.
-
-