...
Javadoc tag | Purpose |
|---|---|
@author | Identifies the programmer who wrote the code. This can be used in multiple lines for the author's name and various forms of contact information. |
@param parameter-name | This tag explains the parameters a particular class or method will accept or expect. Each parameter must be specified individually by name. |
@return | Explains what data a method returns. |
@throws fully-qualified-class-name | Explains the class that throws the exception object, and then explains under what conditions this exception can happen. |
@version | Specifies the release version number of the software that contains this class. |
{@link} | Inserts an in-line link with visible text label that points to the documentation for the specified package, class or member name of a referenced class. |
All of the public and protected classes and methods in all Pentaho software should have sufficient Javadoc. Ideally, an extension developer should be able to read Pentaho Javadoc and gain a decent understanding of what each member does and returns.
...
| Code Block |
|---|
import java.util.*; /** This class prints the following message: Brevity is the soul of wit, * a phrase made famous by {@link <a href="http://en.wikipedia.org/Shakespeare">William Shakespeare</a>}. * By the way... multi-line Javadoc comments * use a carriage return for EOLN (just press Enter), and require * an asterisk at the beginning of each additional * line. * @author Jem Matzan * @author jmatzan@nospam4meplzpentaho.com * @version 2.1.0-RC1 */ public class DocMessage { /** Main method prints the message. * @param args Takes an array of String arguments. * @throws exceptions No exceptions thrown. * @return Nothing!! It's a frickin' void! */ public static void main(String[] args) { System.out.print("Brevity is the soul of wit."); } } |