Java 文档注释

Java 支持三种注释方式。前两种分别是 // 和 /* */，第三种被称作说明注释，它以 /** 开始，以 */结束。

说明注释允许你在程序中嵌入关于程序的信息。你可以使用 javadoc 工具软件来生成信息，并输出到HTML文件中。

说明注释，使你更加方便的记录你的程序信息。

javadoc 标签

javadoc 工具软件识别以下标签：

文档注释

在开始的 /** 之后，第一行或几行是关于类、变量和方法的主要描述。

之后，你可以包含一个或多个各种各样的 @ 标签。每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号(*).

多个相同类型的标签应该放成一组。例如，如果你有三个 @see 标签，可以将它们一个接一个的放在一起。

下面是一个类的说明注释的实例：

1. /*** 这个类绘制一个条形图
2. * @author dandelioncloud
3. * @version 1.2
4. */

javadoc 输出什么

javadoc 工具将你 Java 程序的源代码作为输入，输出一些包含你程序注释的HTML文件。

每一个类的信息将在独自的HTML文件里。javadoc 也可以输出继承的树形结构和索引。

由于 javadoc 的实现不同，工作也可能不同，你需要检查你的 Java 开发系统的版本等细节，选择合适的 Javadoc 版本。

实例

下面是一个使用说明注释的简单实例。注意每一个注释都在它描述的项目的前面。

在经过 javadoc 处理之后，SquareNum 类的注释将在 SquareNum.html 中找到。

SquareNum.java 文件代码：

1. import java.io.*;
3. /**
4. * 这个类演示了文档注释
5. * @author Ayan Amhed
6. * @version 1.2
7. */
8. public class SquareNum {
9. /**
10. * This method returns the square of num.
11. * This is a multiline description. You can use
12. * as many lines as you like.
13. * @param num The value to be squared.
14. * @return num squared.
15. */
16. public double square(double num) {
17. return num * num;
18. }
19. /**
20. * This method inputs a number from the user.
21. * @return The value input as a double.
22. * @exception IOException On input error.
23. * @see IOException
24. */
25. public double getNumber() throws IOException {
26. InputStreamReader isr = new InputStreamReader(System.in);
27. BufferedReader inData = new BufferedReader(isr);
28. String str;
29. str = inData.readLine();
30. return (new Double(str)).doubleValue();
31. }
32. /**
33. * This method demonstrates square().
34. * @param args Unused.
35. * @return Nothing.
36. * @exception IOException On input error.
37. * @see IOException
38. */
39. public static void main(String args[]) throws IOException
40. {
41. SquareNum ob = new SquareNum();
42. double val;
43. System.out.println("Enter value to be squared: ");
44. val = ob.getNumber();
45. val = ob.square(val);
46. System.out.println("Squared value is " + val);
47. }
48. }

如下，使用 javadoc 工具处理 SquareNum.java 文件：

1. $ javadoc SquareNum.java
2. Loading source file SquareNum.java...
3. Constructing Javadoc information...
4. Standard Doclet version 1.5.0_13
5. Building tree for all the packages and classes...
6. Generating SquareNum.html...
7. SquareNum.java:39: warning - @return tag cannot be used\
8. in method with void return type.
9. Generating package-frame.html...
10. Generating package-summary.html...
11. Generating package-tree.html...
12. Generating constant-values.html...
13. Building index for all the packages and classes...
14. Generating overview-tree.html...
15. Generating index-all.html...
16. Generating deprecated-list.html...
17. Building index for all classes...
18. Generating allclasses-frame.html...
19. Generating allclasses-noframe.html...
20. Generating index.html...
21. Generating help-doc.html...
22. Generating stylesheet.css...
23. 1 warning
24. $