| ... | ... | @@ -64,7 +64,6 @@ These are not critical rules, but you should follow them in most cases. |
|
|
|
- **Write a comment defining pre and post-conditions for most methods.**
|
|
|
|
This rule is aimed at improving the readability of the code.
|
|
|
|
- **Write a comment describing every variable when its meaning is not trivial**
|
|
|
|
- **Write a comment describing the purpose of each class, struct and enum**
|
|
|
|
|
|
|
|
For a guide on how to use doxygen to document the code, take a look here: https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html
|
|
|
|
|
| ... | ... | |
