Added example function definition.

This commit is contained in:
Andrew Lalis 2018-06-12 13:12:33 +02:00
parent b7a0bad19f
commit 4a6d2f815c
1 changed files with 29 additions and 3 deletions

View File

@ -20,10 +20,19 @@ If you would like to help contribute to this collection of scripts, or simply in
### Guidelines for Contributing Code ### Guidelines for Contributing Code
To promote uniformity and an organized codebase, there are some guidelines to follow when writing scripts for this repository. To promote uniformity and an organized codebase, there are some guidelines to follow when writing scripts for this repository.
1. All variables and functions should be declared `local` unless required otherwise. 1. All variables and functions should be declared `local` unless required otherwise.
2. All variables should be defined using underscores. For example, ```lua local my_var = 5``` 2. All variables should be defined using underscores. For example,
3. All function names should be defined using camelCase. For example, ```lua local myFunction()``` ```lua
local my_var = 5
```
3. All function names should be defined using camelCase. For example,
```lua
local myFunction()
```
4. A multiline comment should appear above all functions, giving a short description of the function, and a list of all parameters, their expected types, and the return type. 4. A multiline comment should appear above all functions, giving a short description of the function, and a list of all parameters, their expected types, and the return type.
5. Constants should be defined at the top of a file, in all capital characters. For example, ```lua local MY_CONSTANT = 3.14159265``` 5. Constants should be defined at the top of a file, in all capital characters. For example,
```lua
local MY_CONSTANT = 3.14159265
```
6. All `require` statements should be done at the top of the file, above all other things except the file metadata information. 6. All `require` statements should be done at the top of the file, above all other things except the file metadata information.
7. As stated above, each file should have a metadata section, with the following format: 7. As stated above, each file should have a metadata section, with the following format:
```lua ```lua
@ -41,3 +50,20 @@ for actual lines of code.
--]] --]]
``` ```
#### Example Function Definition
```lua
--[[
Gets the maximum of two values.
value_a - number
value_b - number
returns - number
--]]
local myMax(value_a, value_b)
if value_a > value_b then
return value_a
else
return value_b
end
end
```