CS 127: Data Structures
Java Programming Style Directives

Good programming style makes your code much more readable and maintainable. Here are some basic style directives that I expect you to follow in your code. Here is a template for structuring your Java classes, which I encourage to you use.

1. Line up braces. You may have used method (a) in your intro class. The textbook uses method (b), which also happens to be my personal method. Either method is equally acceptable. Consistency is the key here: pick one and stick with it.

   Method (a)	Method (b)
   if (a == b) { c = d; e = f; }	if (a == b) { c = d; e = f; }

2. Use whitespace in a meaningful way to make your code readable.

   • Use tabs/spaces to indicate the level of nesting. The amount of space you use for each tab is up to you, but you should be consistent.
   • Break up lines that are longer than 80 characters. This makes your code much easier to read when printed and when listed in a standard terminal window.

3. Use capitalization and descriptive names to make your identifiers clear.

   • Variable and method names should start with a lower case letter. Capital letters should be used to separate multiple words.

     Examples:

     name, age, personName, getAge

   • Class names should start with a capital letter. Capital letters should be used to separate multiple words.

     Examples:

     class Person, class Gradebook, class BlackjackGame

   • Constants (public static final) should be in all capital letters. Underscores should be used to separate multiple words.

     Examples:

     MAX_CAPACITY, DIME_VALUE

4. Declare your variables with appropriate access.

   • Variables should nearly always be declared private.
   • Methods should be public if they are to be accessed from outside of the class. Otherwise, they should be protected or private.

5. Keep your methods short. A method shouldn't be longer than 1-2 screens without good reasons.

6. Each class header should contain documentation containing

   • Name of class
   • Description of purpose
   • Known bugs

   You may use Javadoc to accomplish this, and I encourage you to do so.

7. Each method should contain header documentation containing

   • Name of method
   • Description of purpose
   • Description of parameters and return value
   • Citations indicating ideas or code borrowed from other people / sources

   You may use Javadoc to accomplish this, and I encourage you to do so.