javadoc实用程序(utility)从下面几个特性中抽取信息:

  • 公有类与接口
  • 公有的和受保护的构造器及方法
  • 公有的和受保护的域

每个/* . . . /文档注释在标记之后紧跟着自由格式文本(free-form text)。
标记由@开始,如@author或@param。
自由格式文本的第一句应该是一个概要性的句子。
javadoc实用程序自动地将这些句子抽取出来形成概要页。
在自由格式文本中,可以使用HTML修饰符,例如,用于强调的、用于着重强调的以及包含图像的4.9 文档注释 - 图1等。不过,一定不要使用


,因为它们会与文档的格式产生冲突。若要键入等宽代码,需使用{@code … }而不是——这样一来,就不用操心对代码中的<字符转义了

类注释

方法注释

  • @param变量描述这个标记将对当前方法的“param”(参数)部分添加一个条目。这个描述可以占据多行,并可以使用HTML标记。一个方法的所有@param标记必须放在一起。
  • @return描述这个标记将对当前方法添加“return”(返回)部分。这个描述可以跨越多行,并可以使用HTML标记。
  • @throws类描述这个标记将添加一个注释,用于表示这个方法有可能抛出异常。

    域注释

    对静态常量注释

    包注释

    需要在每一个包目录中添加单独的文件

  • 提供一个以package.html命名的HTML文件。在标记…之间的所有文本都会被抽取出来。

  • 提供一个以package-info.java命名的Java文件。这个文件必须包含一个初始的以/*和/界定的Javadoc注释,跟随在一个包语句之后。它不应该包含更多的代码或注释