This commit is contained in:
Dennis Eichhorn 2021-11-29 20:08:13 +01:00
parent dfbc71ece0
commit 995f38694c

View File

@ -49,13 +49,13 @@ Never use spaces between variables and atomic operations (e.g. `!`, `++`, `--`)
Don't use whitespace inside ANY parentheses (e.g. functions, loops, conditions, catch, closures). Don't use whitespace inside ANY parentheses (e.g. functions, loops, conditions, catch, closures).
```js ```js
for (let i = 1; i < 100; ++i) { for (let i = 1; i < 100; ++i) {
... ...
} }
``` ```
```js ```js
function(para1, para2) { function(para1, para2) {
... ...
} }
``` ```
@ -200,7 +200,7 @@ All string representations should use single quotes `''` unless `""` provides si
Todos should be documented in the [PROJECT.md](https://github.com/Orange-Management/Docs/blob/master/Project/PROJECT.md). Todos should be documented in the [PROJECT.md](https://github.com/Orange-Management/Docs/blob/master/Project/PROJECT.md).
In code todos can be created like this In code todos can be created like this
```php ```php
// @todo: Single line todo // @todo: Single line todo
@ -208,8 +208,7 @@ In code todos can be created like this
```php ```php
/** /**
* @todo: * @todo: Multi line todo
* Multi line todo
* This way developers can see todos directly in the code without going to an external source. * This way developers can see todos directly in the code without going to an external source.
* Todos must not have empty lines in their descriptions. * Todos must not have empty lines in their descriptions.
* If the external ressources have empty lines they must be removed in the todo comment. * If the external ressources have empty lines they must be removed in the todo comment.