You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/CODECONVENTIONS.md
+7Lines changed: 7 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -33,6 +33,13 @@ Comments:
33
33
* Be concise and only write comments for things that are not obvious.
34
34
* Use // prefix, NOT /* ... */. No extra fluff.
35
35
36
+
Constants:
37
+
* Design for type-safety when possible
38
+
* Use ```enum``` and ```const``` where appropriate
39
+
* Resort to ```#define MACROS``` only when no better option exists or it's a *good* use (get to know the [GNU PreProcessor Common Pitfalls](https://gcc.gnu.org/onlinedocs/cpp/Macro-Pitfalls.html))
40
+
41
+
Error Handling:
42
+
* When possible please use a unified status return from functions, and use pointers to pass arguments in *and* out
0 commit comments