Commit 35c120ee authored by Thomas Haller's avatar Thomas Haller
Browse files

doc: update CONTRIBUTING to no longer allow // FIXME comments

Most of our FIXME/TODO comments are already (rightly) /**/.
Just get rid of this non-obvious inconsistancy in our coding
style.
parent b5a469a8
...@@ -21,13 +21,10 @@ with #ifdef MY_DEFINE / #endif in the code. ...@@ -21,13 +21,10 @@ with #ifdef MY_DEFINE / #endif in the code.
GOOD: g_strdup (x) GOOD: g_strdup (x)
BAD: g_strdup(x) BAD: g_strdup(x)
* C-style comments, except for FIXMEs. * C-style comments
GOOD: f(x); /* comment */ GOOD: f(x); /* comment */
BAD: f(x); // comment BAD: f(x); // comment
GOOD: // FIXME: juice the gooblygok
BAD: /* FIXME: juice the gooblygok */
* Keep assignments in the variable declaration area pretty short. * Keep assignments in the variable declaration area pretty short.
GOOD: MyObject *object; GOOD: MyObject *object;
BAD: MyObject *object = complex_and_long_init_function(arg1, arg2, arg3); BAD: MyObject *object = complex_and_long_init_function(arg1, arg2, arg3);
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment