Coding Standards and Practices for Javascript/ES6 used by Pillar.
- Resolve all errors or warnings before pushing to production!
Variable name specifying content type followed by variable name using first upper-case letters.
sVariableName
stringsiVariableName
integersnVariableName
floatsaVariableName
arraysoVariableName
objectsbVariableName
booleansfVariableName
functions and callbackstVariableName
unix timestamps
Also welcome:
isVariableName
booleanshasVariableName
booleans
Use first upper-case letters for both class and file names.
ClassName
/**
* @name ClassName
*
* @description
* - Description 1
* - Description 2
* - Description 3
* - ...
*/
/**
* @name ClassName.functionName
* @function
*
* @param {type} xVariableName Description
* @param {type} ... ...
*
* @returns {type} xVariableName Description
*
* @description
* - Description 1
* - Description 2
* - Description 3
* - ...
*/
/**
* @name ClassName.propertyName
* @object
*
* @description
* - Description
* - ...
*/
// Explanation content
// ...
// TODO: Task description