Steil’s OOP Coding Style Requirements

• Classes
1. Use humpback notation. The first letter of each word in the class name should be capitalized (this includes the first letter of the class name). Example: SuperHero
2. The class name should describe the data type it describes not any particular instance of it.

• Variables
1. Use humpback notation. The first letter of each word in the class name should be capitalized (this excludes the first letter of the class name). Example: averageBalance.
2. Absolutely no abbreviations, ever!!! But there are a few exceptions.
3. Each variable should be declared on its own line with its own data type listed.
4. Be Descriptive
5. Use Booleans for binary flags (not integers.)
6. Use enumerations or other flags (not integers)
7. Give Boolean variables names that indicate true or false. (Not Status)
8. Prefix all pointers with p.
9. Constants should appear in all capital letters with underscores between each word.
10. If you use a notation such as Hungarian be consistent.
11. Arrays or any other list should be named with a plural name. (For example, playingCards) If the array describes a single entity such as a gameBoard, it can be named as such.
12. Never use global variables. Global constants are good if they are used globally.
13. Never use a variable for multiple purposes.

• Functions
1. No Abbreviations
2. Be Descriptive
3. Void functions should be named with a verb or verb-noun combination.
4. Non-void functions should be named with a noun or an adjective-noun combination. This name should describe the value being returned.
5. Use as many as you can. Even if it is only used once.
6. A function should do only one logical thing. It should be named accordingly.
7. Main should be the first function in the file where it is found.
8. All non-void function should have one and only one return statement. (It must be structured.)
9. No void function should have a return statement.
10. Always include parameter names in function prototypes. This helps document the function.
11. Use humpback notation for all function names. That means the first letter of each word should be capitalized (this excludes the first letter of the function name).

• White space
1. Use it liberally.
2. Place a blank line before and after all control structures.
3. There should be a blank line between each function.
4. All code within a function, switch, if, for, while or do while should be tabbed over one level. Do not use spaces.
5. Put one space between each arithmetic, assignment, or comparison operators and the operands they work on.
6. Within a conditional statement there should always be a leading and trailing space. Example: if( x > y )

• {}
1. Always use {}, switch, if, for, while or do while, even if only one line is contained within the structure.
2. The beginning { should be on the next line after the beginning of a control structure or function.
3. The ending } should be on a line by itself at the end of a control structure or function.

• Comments
1. At the top of each file list:
• Your name
• Course Name
• Assignment Name
2. Never use flower boxes
3. Never repeat the code
4. Never use end of line comments
5. Should not be used to clarify confusing code. Rewrite the code.
6. Comments should explain what not how
7. Comments should not contain code
8. All code that has been “Commented Out” should be removed.
9. Keep comments close to the code they describe
10. Be sure comments are up to date.
11. Document the source of algorithms you use.
12. Document where constant values came from.

• Compiler Messages
1. 10% will be deducted for each compiler warning your program produces in Visual Studio .NET 7.0 (2003).
• If the compiler reports the same warning multiple times the 10% penalty will be deducted for each one.
• There may be some exceptions to this rule; you will be informed in that case.
2. At least 50% will be deducted for a program that will not compile because of compiler errors in Visual Studio .NET 7.0 (2003).

• Comparisons
1. Never compare a Boolean variable with true or false. Just use the value of the Boolean variable in conditions. If you need to reverse the logic use a ‘!’.