From b6ed94fa7cb03350e73509edd3debe41c2309c6d Mon Sep 17 00:00:00 2001 From: wm4 Date: Thu, 13 Mar 2014 00:42:50 +0100 Subject: DOCS/coding-style: add an example and another rule --- DOCS/coding-style.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/DOCS/coding-style.md b/DOCS/coding-style.md index 9c19cd9fc3..8174a92436 100644 --- a/DOCS/coding-style.md +++ b/DOCS/coding-style.md @@ -44,6 +44,31 @@ General formatting ``` - If the body of an if statement uses braces, the else branch should also use braces (and reverse). + + Example: + + ```C + if (a) { + // do something + something(); + something_else(); + } else { + one_line(); + } + ``` +- If an if condition spans multiple physical lines, then put the opening brace + for the if body on the next physical line. (Also, preferably always add a + brace, even if technically none is needed.) + + Example: + + ```C + if (very_long_condition_a && + very_long_condition_b) + { + code(); + } + ``` - Remove any trailing whitespace. - If the file you're editing uses formatting different from from what is described here, it's probably an old file from times when nobody followed a -- cgit v1.2.3