info/the-documentation-compendium
1
0
Fork 0
mirror of https://github.com/kylelobo/The-Documentation-Compendium.git synced 2025-09-03 01:52:42 +02:00
Code Issues Releases Wiki Activity

Formatting changes

Browse Source
This commit is contained in:
Kyle Lobo
2019-07-15 04:05:00 +05:30
committed by GitHub
parent b682891cac
commit 923b3e600b
1 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
CODING_GUIDELINES.md
View File

@@ -1,22 +1,22 @@
# 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 ...)
- 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 ...)