| ... | ... | @@ -59,7 +59,7 @@ These are not critical rules, but you should follow them in most cases. |
|
|
|
- **Use TRACE() instead of printf()** `printf()` is a very heavy function (surprised?) and it's very unlikely you need it when the rocket is flying. TRACEs are like printfs but they are stripped out when compiling the flight binary.
|
|
|
|
|
|
|
|
## **Commenting rules**
|
|
|
|
|
|
|
|
- **Every class shall be documented using a doxygen comment describing the purpose of the class and for what it is useful.**
|
|
|
|
- **Every function shall be documented using a doxygen comment describing the purpose of the function, its parameters and the return value.**
|
|
|
|
- **Write a comment defining pre and post-conditions for most methods.**
|
|
|
|
This rule is aimed at improving the readability of the code.
|
| ... | ... | |
