Name:  Elizabeth Adams

Assignment:  Lab 1 – changes made to code with reasons

Date:  January 12, 2005

Course:  CS 239

 

Blue items are Adams rules

Red items a strongly suggested guidelines – except where truly imappropriate

 

  1. Removed the BREAK statement (Design B.2)
  2. changed the method names to use lowercase except for the first letter of each word other than the first word (Style B.3)
  3. Fixed indentation (Style C.1, C.2, C.3)
  4. Variables should be declared at the top of a method – START isn’t
  5. Shouldn’t declare and initialize in the same statement -  BufferedReader stdin
  6. START isn’t a constant so it should be in lower case (Style B.3)
  7. Should give user range of numbers that are valid first (Style E.4)
  8. Moved the methods that printed the verse to another class because shouldn’t have other methods in same class as main (Design C.1)
  9. It would be nice to tell the user what the program will do (i.e. provide an intro)
  10. Verse should not be capitalized.  It is a variable not a class (Style B.2)
  11. Added header documentation (Documentation C.2)
  12. Added comments (Documentation D.1, D.2)
  13. changed variable name START to numberOfBottles (Style A.1, A.2, B.3)
  14. The input to your program should be echoed back to the user