CS 111 - 1/27/15


For submission:  send the .java file(s) and if needed
                    any media files


Commenting of the code:

  - remarks included in the program that are
      not meant for the computer, these remarks 
      are intended for people to read

   Syntax:   //  comment information

       End of line comment - anything from
         the double slash to the end of the line
         is part of the comment and ignored by
         the compiler 


   Syntax: /*    comment information */

       Block comment - anything between the /* and
          the */ is part of the comment and ignored 
          by the compiler

       Block comments can span multiple lines


Use of Comments - Add understand to the text of
    the program.   Often explains the "Why?" of the
    code


  In-line comment - described a few lines of code

  File Header Block
         - who wrote the code
         - when the code was written
         - What is this code written for
         - overall description of the entire program

  Method Header Block
         - describe the purpose of the method
         - describe all of the arguments/parameters
         - describe the RETURN value


 Stepwise development - write our program in small
      "chunks".   Verify each chunk is working properly
      before moving on the the next chunk.

      This technique helps reduce the amount of time
      identifying and fixing errors.

Types of Errors

   Syntax Error / Compiler Error
     - Errors found by the compiler

   Logic Error
     - program runs but produces the wrong results
     - These are WAY HARDER to figure out than Syntax Errors


To set up the software for CS 111, we need 3 things:

  1.   Java Compiler - Java Development Kit "JDK"
          Download JDK version 7

  2.   DrJava IDE

  3.   BookClasses Library from the Author