Use the following coding guidelines when creating and editing players.
Use the following naming conventions:
| Convention | Explanation |
|---|---|
| Function | functionNamesLikeThis |
| Variable | variableNamesLikeThis |
| Class | ClassNamesLikeThis |
| Enum | EnumNamesLikeThis |
| Constant | CONSTANT_VALUES_LIKE_THIS |
| Private | Private properties and methods should be named with a trailing underscore: _myPrivateVar |
| Public | Public properties and methods should be named without a trailing underscore: myPublicVar. |
Prefer ' over "
For consistency’s sake, single-quotes (‘) are preferable to double-quotes (“). This is especially important when creating strings that include HTML:
var h1 = '<h1>This is some HTML</h1>';
Function parameters must be declared with their types:
function exampleFunction(text: String, obj: Object, ... )
Function parameters must be typed with JSDoc annotations in the JSDoc preceding the function’s definition.
The functions return value type must be appear in the function declaration:
function exampleFunction( ... ): Promise<*> {
...
}
The function return types must be specified in the JSDoc directly above the function definition.
f.bind(this), and especially over kalt.bind(f, this).var self = this.Braces are requires for all control structures (e.g., if, else, for, do, while as well as any others), even if the body contains only a single statement. The first statement of a non-empty block must begin in its own line.
Important! Do not use the following structure:
if (someVeryLongCondition()) doSomething();
for (let i = 0; i < foo.length; i++) bar(foo[i]);
Block indentation is +2 spaces. Each time a new block or block-like construct is opened, the indent increases by two spaces. When the block ends, the indent returns to the previous indent level. The indent level applies to both code and comments throughout the block.
Type names must start with a Capital letter (pascal case), e.g.:
type CategoryType = {[category: string]: number};
export type {CategoryType};