mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager
synced 2024-10-02 22:38:01 +00:00
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.
This commit is contained in:
parent
b5a469a894
commit
35c120ee15
|
@ -21,13 +21,10 @@ with #ifdef MY_DEFINE / #endif in the code.
|
|||
GOOD: g_strdup (x)
|
||||
BAD: g_strdup(x)
|
||||
|
||||
* C-style comments, except for FIXMEs.
|
||||
* C-style comments
|
||||
GOOD: 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.
|
||||
GOOD: MyObject *object;
|
||||
BAD: MyObject *object = complex_and_long_init_function(arg1, arg2, arg3);
|
||||
|
|
Loading…
Reference in a new issue