mirror of
https://github.com/kylelobo/The-Documentation-Compendium.git
synced 2025-09-30 22:46:53 +02:00
23 lines
1.2 KiB
Markdown
23 lines
1.2 KiB
Markdown
# Coding Guidelines
|
|
|
|
- You can validate that your code complies with these guidelines by running `stuff/php-format.py validate`
|
|
- Tabs, no spaces
|
|
- End of line should should be Unix style (`\n`), not Windows style (`\r\n`)
|
|
- Opening brackets goes in the same line as the last statement
|
|
```
|
|
if (condition) {
|
|
stuff;
|
|
}
|
|
```
|
|
- A space between keywords and parenthesis for: `if`, `else`, `while`, `switch`, `catch`, `function`
|
|
- Function calls have no space before the parentheses
|
|
- No spaces are left inside the parentheses
|
|
- A space after each comma, but without space before
|
|
- All binary operators must have one space before and one after
|
|
- There should not be more than one contiguous blank line
|
|
- There should be no empty comments
|
|
- You should not use block comments `/ * ... * /`, only line `// ...`
|
|
- Changes in functionality must be accompanied by their respective new / modified tests
|
|
- Exceptions must be used to report erroneous states. The use of functions that return true / false is allowed when they are expected values
|
|
- Use [RAII] (http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization) when appropriate, mainly in the administration of resources (files, etc ...)
|