Skip to content

Changes

Page history
Update Coding Guidelines authored by Luca Erbetta's avatar Luca Erbetta
Show whitespace changes
Inline Side-by-side
Coding-Guidelines.md
View page @ 2fa5a4cb
...@@ -73,6 +73,7 @@ Split functions in multiple ones to improve readability of the code ...@@ -73,6 +73,7 @@ Split functions in multiple ones to improve readability of the code
## **Naming conventions** ## **Naming conventions**
- **Function will be named using camelCaseNotation, starting with a lower case letter** - **Function will be named using camelCaseNotation, starting with a lower case letter**
Example: `float readTemperatureSample()` Example: `float readTemperatureSample()`
Exception: Acronyms in function names will be UPPERCASE. Example: `bool selfTestIMU()`
- **Classes, structs and enums will be named using CamelCaseNotation** - **Classes, structs and enums will be named using CamelCaseNotation**
Example: `class TemperatureSensor{};` Example: `class TemperatureSensor{};`
- **Constants and enum members will be named using ALL_CAPS_WITH_UNDERSCORES** - **Constants and enum members will be named using ALL_CAPS_WITH_UNDERSCORES**
......