forked from mrkubax10/industrialtest
Some updates to CODING_STYLE.md
This commit is contained in:
parent
f8a43e567d
commit
84c309ac5a
@ -5,7 +5,24 @@ You should use tabs for indentation.
|
||||
## Naming convention
|
||||
Use `lowerCamelCase` for functions, variables and table keys. Use `UPPER_SNAKE_CASE` for constants and `lower_snake_case` for filenames.
|
||||
|
||||
## Other
|
||||
## Blocks
|
||||
Keywords used to open blocks (i.e. `then`, `do`) should go to the same line as the statement:
|
||||
```lua
|
||||
if condition then
|
||||
...
|
||||
end
|
||||
```
|
||||
or:
|
||||
```lua
|
||||
while condition do
|
||||
...
|
||||
end
|
||||
```
|
||||
|
||||
## Variables
|
||||
General rule is to keep as much variables local as possible. If variable must be global then it should go to `industrialtest` table also under subnamespace if appropriate (the same applies to functions).
|
||||
|
||||
## Tables
|
||||
If table contains one element then it can be inlined:
|
||||
```lua
|
||||
someTable={element}
|
||||
|
Loading…
Reference in New Issue
Block a user