Style Guidelines

Code readability and maintainability are both incredibly important. It is essential that you develop a consistent coding style for yourself as well as anyone who may look at your code in the future. Below are a few common guidelines that you should incorporate into your code.

Excerpts from Java Software Solutions 5th edition by Lewis&Loftus (Appendix F)

Identifier Naming

Method and variable names generally start with a lowercase letter and class names normally start with an uppercase letter. Identifiers are often a multi-word description of what they are identifying, and uppercase letters are used to specify word breaks. For example, a variable representing a first name might be called firstName . A class representing a bank account might be called BankAccount .

Indentation

Code between an open brace ({) and the corresponding close brace (}) should be indented a consistent number of spaces. This applies to if statements, loops, method definitions, and class definitions. The close brace should always be lined up with the header of the statement. L&L suggest that the open brace be on a new line, however putting the open brace at the end of the header line is also common. Choose your own style, and be consistent !

Examples:

   if(firstName.equals("Bob"))
   

   {
   

   //all code indented by the same amount
   

   System.out.println("Short for Robert?");
   

   System.out.println("Or is that your full name?");
   

   }
   

   

   public static void main(String[] args) { //open brace at the end of the header line
   

   //all code indented by the same amount
   

   System.out.println("Hello, world");
   

   }

Navigation

Graduate Programs