Tips to Writing Clean Code
Functions:
• Function names should consist of a verb and a noun which describe the function’s purpose. Capitalize the first
letter of each word in the function. Example: Print() vs. PrintStudentList()
• A function should have a single purpose. Example: Figuring an average, printing a student list, and getting input
in one function vs. 3 functions which perform each of those actions.
• Functions which return a single value should generally do this through a return statement, not through the
parameter list.
• A function that won’t fit on a single printed page is typically too complex/long and should be broken into smaller
pieces.
• Every function should have a header containing an accurate description of the function and its parameters.
Someone reading your code should not have to search through the function’s body to understand what the
function is really doing.
Code:
• Use plenty of white space to clarify code.
• Indent properly to show structure, and be consistent with your indentation throughout the entire program.
• Put statements ending with semicolons and { } on separate lines (except for loops).
for (i=o;i<5;i++) vs.
{ cout<<i*j; j=j-3; }
for (i = 0; i < 5; i++)
{
cout << i * j;
j = j - 3;
}
Variables / Constants:
• Carefully chosen variable names and constants will often be self-documenting.
Example: c = a - b; vs. score = total_points - points_missed;
• Declare all variables at the top of the function.
• Variables should generally not be initialized to a computed value on the same line on which it’s declared
although initialing to a constant is acceptable. Example: int c = sqrt(b); vs. int c = 0;
• Comment the purpose of each variable declaration.
• Constants should generally be all capitalized, and variables should generally be all lower case.
Example: const int NAME_LEN = 4; and int num_of_students = 20;
• Use constants for all “magic numbers” or whenever a particular value is used more than once.
