PennWest Edinboro CS Wiki

User Tools

Site Tools

Trace: • indentation
guides:programstyle:indentation

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
guides:programstyle:indentation [2020/07/24 12:24] – [Code in a Code Block] wikiadminguides:programstyle:indentation [2022/08/02 11:59] (current) – external edit 127.0.0.1
Line 5: Line 5:
 ===== Code in a Code Block ===== ===== Code in a Code Block =====
  
 +Code inside of a code block,enclosed in {}, or that constitutes the body of a control structure should be indented.  This allows programmers reading the code to instantly identify the body of these control structures.
 +
 +Example of acceptable use:
 <code c++> <code c++>
 int value; int value;
Line 29: Line 32:
    cin >> value;    cin >> value;
 } }
 +</code>
 +
 +Code should be indented by a standard amount.  In general one space is too little to allow easy visual identification of the control structure.  You should not use tabs for indentation.  If you wish to use tabs, or your editor auto indents with tabs, you should replace tabs with spaces.
 +
 +Unacceptable Example:
 +<code c++>
 +int value;
 +
 +int max, 
 +min;
 +    
 +int count = 0;
 +
 +cin >> value;
 +    max = value;
 + min = value;
 +
 +while (cin) {
 +if (max < value) {
 +max = value;
 +}
 +   
 +             if (min > value) {
 +      min = value;
 +      }
 +   
 +   count++;
 +           cin >> value;
 +                       }
 </code> </code>
 ===== A single statement occupying multiple lines ===== ===== A single statement occupying multiple lines =====
 +
 +A second use of indentation is to highlight a line of code which wraps past the maximum line limit.  This frequently occurs in parameter lists, output statements and variable declarations.    Indentation gives programmers a visual clue that the line has been wrapped.
 +
 +In a long parameter list, break the line at the beginning of a parameter declaration and align the next parameter declaration with the first declaration on the line above it.
 +
 +<code c++>
 +void FloodFill(int & worldArray[MAX_ROWS][MAX_COLUMNS], int rowSize, 
 +               int colSize, int fillColor, int backgroundColor,
 +               int currentRow, int current column);
 +</code>
 +
 +When declaring multiple variables of a single type it is helpful to indent each new identifier, especially when variables are initialized in the same statement.
 +
 +<code c++>
 +    int rowSize = 10,
 +        colSize = 20,
 +        fillColor = 4,
 +        backgroundColor = 7;
 +</code>
  
    
  
guides/programstyle/indentation.1595593479.txt.gz · Last modified: 2022/08/02 11:59 (external edit)