CheckStyle Lab -- Creating Stylish Code

1. Check the box for soft tabs (this inserts spaces instead of the special tab (\t) character
2. Set the tab size to 3 (this is the default, so, you should just need to verify this).

Actions:

1. Directory Structure If you haven't already, you should create a top-level CS149 folder/directory to organize all your labs and other assignments for the semester. Create a directory called CheckstyleLab under your CS149 folder.
2. Download Payroll.java and move Payroll.java into the Checkstyle directory.
3. Correct all of the style errors in this file, using the () icon to run checkstyle.
4. After eliminating all of the style errors, submit your assignment to Autolab. Each student must submit a copy to Autolab to receive credit.

1. Every class must contain a Javadoc comment (below is an example). This comment contains:
   • The first line must be a //* as shown in the example. The other lines must start with the aligned astericks characters.
   • A short description of what the class does. This description must end with a period (otherwise Checkstyle will mark it as an error).
   • The next line starts with @author, followed by the name of the original person who wrote the class
   • The next line starts with @version. In this class, you can just put the due date of the assignment for the version.
   • The honor code acknowledge is next.
   • This is a block comment, which ends with the sequence */. Java treats all information between the //* and the */ as a comment (which can span many lines, as it does in this example).

   /**
                             * Overall description of the class goes here.
                             *
                             * @author Your name goes here
                             * @version Due date goes here
                             * Acknowledgements: I received no outside help on this assignment and have
                             * abided by the JMU Honor Code.
                             */

2. All methods (including main) must contain an applicable Javadoc comment as shown in the following example.

/**
                          * Overall description of the method goes here.
                          *
                          * @param parameterName describe the first parameter
                          * @param parameter2 description of 2nd parameter
                          * @return
                          */

3. Inline comments (//) should describe major structures and steps within a method.
4. All comments should use normal English spelling and grammar. Phrases are OK
5. Comments must come before the code that they are describing or on the same line.

1. All names should be descriptive and readable. (subTotal rather than s,   grade rather than grd)
2. Multiple-word names should use capital letters to separate words. (subTotal, not sub_total)
3. Variable and method names should begin with a lowercase letter, and:
   • Variable names should be nouns or noun phrases. (studentName or subTotal)
   • Method names should be verbs or verb phrases. (printLine or addColumn)
4. Class names should begin with a capital letter and use title case. (HelloWorld)
5. Constant names should be all caps with an underscore separator. (PI or INTEREST_RATE)

final double CENTIMETERS_PER_INCH = 2.54;
                            centimeters = inches * CENTIMETERS_PER_INCH;    // NOT inches * 2.54;

1. All constants should be named and initialized at the top of the method in which they are used.
2. All variables should also be declared at the top of the method, directly after any constant declaraions.
3. It is strongly recommended (in CS 149) to separate variable declaration and initialization statements.
4. Each declaration should be on its own line. Comment to the right if the name is not self-explanatory.

Scanner input = new Scanner(System.in);    // discouraged
                            Scanner input;
                            input = new Scanner(System.in);

1. Numeric literals should be of the correct type for the context in which they are used.

// integer expressions should use integer literals
                    int a;
                    double b;
                    a = 2;
                    b = 2.0;

                    // double expressions should use double literals
                    double x;
                    double y;
                    double average;
                        average = (x + y) / 2.0;    // NOT 2, which is an integer

1. Subsections of code should be indented consistently with three spaces.
2. Always use three space characters, not tab characters, for indentation.
3. Statements too long for one line should be indented on subsequent lines.
4. All blocks of code (even if one line) should be surrounded by curly braces.
5. Left braces must appear on the same line as the structure header.

1. There should be a space after cast operators, commas, and //'s.
2. Use whitespace to separate logical segments of code. There should be a blank line after variable declarations.
3. Lines should be kept to a short length (< 80 chars). You should be able to see the full line in your text editor.
4. Binary operators should be separated from their operands by a single space. (sum = myGrade + yourGrade;)
5. One exception is the dot (.) operator, which should not have space surrounding it. (System.out.println();)
6. Unary operators should not be separated by a space. (myGrade++;)