|
Bill Teter email: william.teter@plattsburgh.edu |
|
|
Documentation guidlines
Every class file that you submit should contain your name, date, assignment number and a brief description of the purpose of the class. A method will need explicit specification if it is not obvious from the method's name. For example getName() does not need further explanation, but something like process(Data d) probably does. The specification may include preconditions. For example, if one of the parameters is assumed not to be null in order to avoid exception this should be mentioned as a precondition. If a method changes the state of an object the post condition should explain that change. If the method returns a value (and it is not obvious) explain what is returned. The general format for specifying a method is: public Stuff example(Parameter p){ |