javascript/NativeScript
1
0
Fork 0
mirror of https://github.com/NativeScript/NativeScript.git synced 2025-08-17 21:01:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3897 from NativeScript/etabakov/fix-wrong-example

Browse Source 
Fix wrong example of Quotes usage
This commit is contained in:
Alexander Vakrilov
2017-03-30 13:38:45 +03:00
committed by GitHub
parent 8b799378c6 05fe7d4f7c
commit 23c7d84105
1 changed files with 16 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
CodingConvention.md
View File

@ -1,6 +1,6 @@
#TSN-Modules Coding Convention# # TSN-Modules Coding Convention#
##Linting ## Linting
*TODO: We should further verify this may work with TypeScript* *TODO: We should further verify this may work with TypeScript*
@ -55,13 +55,13 @@ Use single quotes, unless you are writing JSON.
*Right:* *Right:*
~~~ {.javascript} ~~~ {.javascript}
var foo = "bar"; var foo = 'bar';
~~~ ~~~
*Wrong:* *Wrong:*
~~~ {.javascript} ~~~ {.javascript}
var foo = 'bar'; var foo = "bar";
~~~ ~~~
## Braces ## Braces
@ -283,7 +283,8 @@ if (a == '') {
[comparisonoperators]: https://developer.mozilla.org/en/JavaScript/Reference/Operators/Comparison_Operators [comparisonoperators]: https://developer.mozilla.org/en/JavaScript/Reference/Operators/Comparison_Operators
##Short-hand oprators ## Short-hand oprators
Try to avoid short-hand operators except in very simple scenarios. Try to avoid short-hand operators except in very simple scenarios.
*Right:* *Right:*
@ -302,7 +303,8 @@ var big = (x > 10) ? checkX(x)?getExtraLarge():getDefaultSize():getSmallValue();
~~~ ~~~
##Curly braces ## Curly braces
Always use curly braces even in the cases of one line conditional operations. Always use curly braces even in the cases of one line conditional operations.
*Right:* *Right:*
@ -324,7 +326,8 @@ if (a)
if (a) return 'winning'; if (a) return 'winning';
~~~ ~~~
##Boolean comparisons ## Boolean comparisons
**Do not** directly compare with true, or false. **Do not** directly compare with true, or false.
*Right:* *Right:*
@ -548,7 +551,8 @@ function doAsync(arg, onSuccess, onError) {
} }
~~~ ~~~
##Comments ## Comments
Use the [JSDoc][JSDOC] convention for comments. When writing a comment always think how understandable will be for somebody who is new to this code. Even if it may look simple to you think how a guy that just joined will understand it. Always comment in the following cases: Use the [JSDoc][JSDOC] convention for comments. When writing a comment always think how understandable will be for somebody who is new to this code. Even if it may look simple to you think how a guy that just joined will understand it. Always comment in the following cases:
+ When there is some non-trivial logic. + When there is some non-trivial logic.
+ Some 'external' knowledge is needed which is missing in the context - workaround for driver, module bug, special 'hack' because of a bug and so on; + Some 'external' knowledge is needed which is missing in the context - workaround for driver, module bug, special 'hack' because of a bug and so on;
@ -559,7 +563,8 @@ Use the [JSDoc][JSDOC] convention for comments. When writing a comment always th
[param]: http://usejsdoc.org/tags-param.html [param]: http://usejsdoc.org/tags-param.html
##Commenting of parameters that are objects/complex types ## Commenting of parameters that are objects/complex types
When you have parameters that are complex objexts like *options* or other type for which the properties are not clear or is external one use the [@type-def tag][typedef] When you have parameters that are complex objexts like *options* or other type for which the properties are not clear or is external one use the [@type-def tag][typedef]
*Right:* *Right:*
@ -598,7 +603,8 @@ function checkProperties(properties) {
[typedef]: http://usejsdoc.org/tags-typedef.html [typedef]: http://usejsdoc.org/tags-typedef.html
##File/module structure ## File/module structure
Typical module should have the following structure: Typical module should have the following structure:
1. required dependencies 1. required dependencies