Unformatted text preview: must include an @author and @params, if appropriate ===================================================== Here is additional information regarding use of Javadoc. 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 every method declaration. @param The @param entries shouldt have the same parameter spelling as the parameter @returns The @returns tells the programmer what is ‘returned’ from the method. /** * description of method. Include a very short description of the purpose of the method * @param e.g. This method expects three integers * @return This method returns a character grade computed from averaging three integers */ public void demoMethod(String myparam) { . ..}...
View
Full Document
- Summer '08
- ROGGIO,R
- @author, @param, @return, @returns, @params
-
Click to edit the document details