CSC 331 coding conventions
- Class names must begin with upper case letters.
- Variable names must begin with lower case letters.
- Method names must begin with lower case letters.
- If a name consists of multiple words, capitalize the first letter of each subsequent word. For example, lastName.
- All instance variables must be declared private.
- Choose reasonable, defensible, descriptive names for variables.
- Use a consistent format for your code. Eclipse can format your code for you. See Source/Format on the menu.
- Declare variables with the proper scope. For instance, do not use an instance variable where a local variable will do.
- Typically, loop index variables are named i,j,k etc. Follow this convention.
- Follow the format shown here for Javadoc comments. Here is another page that presents basic ideas about good formats for Javadoc.