Udel CISC370-010 2000F info

Here are some links & help for starting out.


Some help with javadoc

import ...
    //comment for main program after import statements
 /**
  * @author Cool Programming Dude
  * @version 1.0
  *
  * A simple program
  */
...
 //class....
 public class Helper
 {

 
 /**
  * @param String hello, String goodbye
  *
  * A simple method
  */
 
  //now a method
  public void printMe(String hello, String goodbye)
  {
   ...
  } //end method
 } //end class
Such comments will show up in your html pages produced by the javadoc program. Javadoc is found in the same bin directory as java, javac, etc... Try
% javadoc -help
to see a list of parameters for running the program. Here is what you need to do with your source:
% javadoc -author -version Sourcecode.java
(-version and -author forces javadoc to include the author and version tags)
Then move all the .html files produced by the program to your webpage under something like ~/public_html/cisc370/hw1/.

Naming conventions

One other thing to mention is the naming convention in your programs:
All class names should begin with an uppercase letter. For example in Mysource.java, the class name will be Mysource.
All methods should start with a lowercase letter and if it is more than one word, the second word and so on should be caps. Ex:
 //....
 public void print()
 //...
 public void displayMe()
 //...
 public void displayInMyPage()