6.6　Javadoc标签

我们在 4.9 节中讨论了如何用 /** 编写文档注释。一般而言，最好给每个类和方法都编写文档，这样其他程序员无需阅读代码就能知道它们是做什么的。

为将文档分成多个部分，Javadoc 支持以 @ 打头的可选标签（tag）。例如，可用标签 @param 和 @return 提供有关形参和返回值的额外信息。

  1. /**
  2.  * 检查整数x是否是个位数
  3.  *
  4.  * @param x 要检查的整数
  5.  * @return 如果x是个位数，返回true，否则返回false
  6.  */
  7. public static boolean isSingleDigit(int x) {

图 6-1 显示了 Javadoc 生成的 HTML 页面。请注意其中的源代码和文档之间的关系。

{%}

图 6-1：isSingleDigit 的 HTML 文档

如果方法有多个形参，那么应该用不同的 @param 标签描述每个形参。void 方法没有返回值，因此不需要 @return 标签。