importjava.io.*;
/**
* 这个类演示了文档注释
* @author Ayan Amhed
* @version 1.2
*/publicclassSquareNum{/**
* This method returns the square of num.
* This is a multiline description. You can use
* as many lines as you like.
* @param num The value to be squared.
* @return num squared.
*/publicdoublesquare(doublenum){returnnum * num;
}/**
* This method inputs a number from the user.
* @return The value input as a double.
* @exception IOException On input error.
* @see IOException
*/publicdoublegetNumber()throwsIOException{InputStreamReaderisr = newInputStreamReader(System.in);
BufferedReaderinData = newBufferedReader(isr);
Stringstr;
str = inData.readLine();
return(newDouble(str)).doubleValue();
}/**
* This method demonstrates square().
* @param args Unused.
* @return Nothing.
* @exception IOException On input error.
* @see IOException
*/publicstaticvoidmain(Stringargs[])throwsIOException{SquareNumob = newSquareNum();
doubleval;
System.out.println("Enter value to be squared: ");
val = ob.getNumber();
val = ob.square(val);
System.out.println("Squared value is " + val);
}}
如下，使用 javadoc 工具处理 SquareNum.java 文件：
$ javadoc SquareNum.java
Loading source file SquareNum.java...ConstructingJavadoc information...StandardDoclet version 1.5.0_13Building tree for all the packages and classes...GeneratingSquareNum.html...SquareNum.java:39: warning -@return tag cannot be used\
in method withvoidreturn type.Generatingpackage-frame.html...Generatingpackage-summary.html...Generatingpackage-tree.html...Generating constant-values.html...Building index for all the packages and classes...Generating overview-tree.html...Generating index-all.html...Generating deprecated-list.html...Building index for all classes...Generating allclasses-frame.html...Generating allclasses-noframe.html...Generating index.html...Generating help-doc.html...Generating stylesheet.css...1 warning
$
