import ... import ... /** * Class comments * Describe what the class does: what is its purpose, what * problem does it solve, known bugs, etc. * * CS 127, Winter 2005 * Assignment # * Date: the due date of the assignment * * @author your name(s) */ class ClassName { /* Variable declarations. Here's a sample. */ /** description of var1 */ private int var1; /** description of var2 */ private int var2; ... /* Public method declarations go here. Here's a sample. */ /** * Comment that briefly describes what the method does * * @param param1 Brief description of what this input parameter is * @param param2 Ditto * ... * @return Brief description of what this method returns. * If nothing is returned, omit this statement. */ public int returnAnInteger(double param1, int param2, ...) { ... } /* Private method declarations go here. Follow the same format as the public methods. */ /** * The main method for this class, if it exists. * @param args A description of the command line arguments, if any */ public static void main(String[] args) { ... } }