quareNum.java 文件代码：

import java.io.*; /** * 这个类演示了文档注释 * @author Ayan Amhed * @version 1.2*/public class SquareNum {   /**   * 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.   */   public double square(double num) {      return num * num;   }   /**   * This method inputs a number from the user.   * @return The value input as a double.   * @exception IOException On input error.   * @see IOException   */   public double getNumber() throws IOException {      InputStreamReader isr = new InputStreamReader(System.in);      BufferedReader inData = new BufferedReader(isr);      String str;      str = inData.readLine();      return (new Double(str)).doubleValue();   }   /**   * This method demonstrates square().   * @param args Unused.   * @return Nothing.   * @exception IOException On input error.   * @see IOException   */   public static void main(String args[]) throws IOException   {      SquareNum ob = new SquareNum();      double val;      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.javaLoading source file SquareNum.java...Constructing Javadoc information...Standard Doclet version 1.5.0_13Building tree for all the packages and classes...Generating SquareNum.html...SquareNum.java:39: warning - @return tag cannot be used                      in method with void return type.Generating package-frame.html...Generating package-summary.html...Generating package-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
$