CS 117: Introduction to Computer Science
Java Programming Style
1. Line up braces. You'll find that the textbook tends to use method (a),
whereas I tend to use method (b). Either method is equally acceptable --
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.
-
Break up lines that are longer than 80 characters.
3. Use capitalization 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 should be in all capital letters. Underscores should be used
to separate multiple words. Examples:
MAX_CAPACITY, DIME_VALUE
4. Keep your methods short. A method shouldn't be longer than 1-2
screens without good reasons.
5. Each class should contain header documentation containing:
-
Programmer's name
-
Date
-
Assignment Number / Name
-
Name of class
-
Description of purpose
-
Known bugs
Use Javadoc where appropriate.
6. Every 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
Use Javadoc where appropriate.