MoreWordsOnJavadoc

MoreWordsOnJavadoc - /** * description of method * @param...

Info iconThis preview shows page 1. Sign up to view the full content.

View Full Document Right Arrow Icon
Here is additional information regarding use of Javadoc. This is cut and paste [with a bit of editing]from an email from Mr. Zucker, who is our resident expert on Javadoc. This all works, so follow these words below, please. Class Javadoc Information : It is imperative you put the class javadoc comments directly in front o f the class declaration (as opposed to the front of the file before the package or import statements). Method javadoc Information Put the method javadoc comments directly before the method declaration. @param The @param entries must have the same parameter spelling as the parameter see example below:
Background image of page 1
This is the end of the preview. Sign up to access the rest of the document.

Unformatted text preview: /** * description of method * @param myparam this doc will work since there is a parameter called myparam (See below) * @param mynextparam param will not work since there is no parameter called mynextparam */ public void demoMethod(String myparam) { . ..} Call to Javadoc Remember to call javadoc with: (your class name) javadoc -author -private MyClass.java, so that the author's name will appear and all methods will also appear. For more info please see: http://www.unf.edu/~rzucker/cop3540dir/standard.html#Comments Pay attention to his Comments and Samples sections. They are helpful....
View Full Document

This note was uploaded on 07/26/2011 for the course COP 2551 taught by Professor Roggio,r during the Summer '08 term at UNF.

Ask a homework question - tutors are online