Differences

This shows you the differences between two versions of the page.

--- guides:programstyle:codeblocks [2020/07/24 14:23] – wikiadmin
+++ guides:programstyle:codeblocks [2024/07/25 15:01] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ====== Compound Statements or Code Blocks ======
+===== Short Answer =====
+The body of all control structures should be enclosed in a code block.  This rule applies to control structure bodies with a single simple statement.
+Acceptable examples:
+<code c++>
+if (x > 5) {
+   big = true;
+}
+for (i = 0; i < 10; i++) {
+   cout << i << endl;
+}
+do {
+   ProcessItem(count);
+} while ( count < 7);
+</code>
+Unacceptable examples:
+<code c++>
+if (x > 5)
+   big = true;
+for (i = 0; i < 10; i++)
+   cout << i << endl;
+do
+   ProcessItem(count);
+while ( count < 7);
+</code>
+===== Discussion =====
 In c/c++ statements can be grouped into a single statement using a code block or "curly braces".  The most common use of a code block is to extend the content of the body of a control structure to include more than one statement.
@@ Line 11: / Line 46: @@
 <code>
    if (boolean expression) {
-       statement1;
+       statement_1;
-       statement2;
+       statement_2;
        ...
-       statementn;
+       statement_n;
    }
 </code>
+When the body of a control structure, such as if, is a single statement, code blocks are not required, however a common convention is to require code a code block for any control statement.
+The main reason for this convention is that it allows programmers to modify code without introducing errors.
+Consider the following example:
+<code c++>
+for(i = 0; i < 10; i++)
+    Process(i);
+</code>
+Assume that //Process// is designed to output a message, however it has a bug in it so it does not produce any output.  A first step at debugging may be to modify the loop as follows:
+<code c++>
+for(i = 0; i < 10; i++)
+    cout << "In the loop, i = " << i << endl;
+    Process(i);
+</code>
+Unfortunately, this has further broken the code.  The programmer probably assumes that both lines following the for loop will be executed as the body of the loop, but this is not the case.  Only the output line will be executed.  Had the programmer followed the convention of always placing the body of a control structure in a code block, this would not be the case.
+Failure to follow this convention leads to bugs so frequently that as of g++6, there is a flag to warn when this situation occurs (-Wmisleading-indentation).