... | @@ -53,6 +53,8 @@ Enum classes restrict the scope of their members and are strongly-typed. |
... | @@ -53,6 +53,8 @@ Enum classes restrict the scope of their members and are strongly-typed. |
|
- **The return value of non-void functions must be checked by each calling**
|
|
- **The return value of non-void functions must be checked by each calling**
|
|
This is done to check if the function had an error.
|
|
This is done to check if the function had an error.
|
|
- **Use C++ style cast (static_cast, dynamic_cast…) instead of their C counterparts**
|
|
- **Use C++ style cast (static_cast, dynamic_cast…) instead of their C counterparts**
|
|
|
|
- **Initialize objects in their costructors: avoid init() functions when possible**
|
|
|
|
It's very easy to forget to call an object's init() method, leaving objects in a undefined state.
|
|
|
|
|
|
## **Commenting rules**
|
|
## **Commenting rules**
|
|
- **Every function shall be preceded by a doxygen-style comment describing the purpose of the function, its parameters and the return value.**
|
|
- **Every function shall be preceded by a doxygen-style comment describing the purpose of the function, its parameters and the return value.**
|
... | | ... | |