Merge branch 'jk/coding-guidelines-update' into maint
Developer doc update. * jk/coding-guidelines-update: CodingGuidelines: clarify multi-line brace style
This commit is contained in:
commit
63f1bb8109
@ -206,11 +206,38 @@ For C programs:
|
||||
x = 1;
|
||||
}
|
||||
|
||||
is frowned upon. A gray area is when the statement extends
|
||||
over a few lines, and/or you have a lengthy comment atop of
|
||||
it. Also, like in the Linux kernel, if there is a long list
|
||||
of "else if" statements, it can make sense to add braces to
|
||||
single line blocks.
|
||||
is frowned upon. But there are a few exceptions:
|
||||
|
||||
- When the statement extends over a few lines (e.g., a while loop
|
||||
with an embedded conditional, or a comment). E.g.:
|
||||
|
||||
while (foo) {
|
||||
if (x)
|
||||
one();
|
||||
else
|
||||
two();
|
||||
}
|
||||
|
||||
if (foo) {
|
||||
/*
|
||||
* This one requires some explanation,
|
||||
* so we're better off with braces to make
|
||||
* it obvious that the indentation is correct.
|
||||
*/
|
||||
doit();
|
||||
}
|
||||
|
||||
- When there are multiple arms to a conditional and some of them
|
||||
require braces, enclose even a single line block in braces for
|
||||
consistency. E.g.:
|
||||
|
||||
if (foo) {
|
||||
doit();
|
||||
} else {
|
||||
one();
|
||||
two();
|
||||
three();
|
||||
}
|
||||
|
||||
- We try to avoid assignments in the condition of an "if" statement.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user