5 文档注释

Wu Jun 2019-12-30 22:43:49
05 Java > 00 Java 基础 > 02 对象与类

1 注释方法

三种注释方法,注释不会出现在可执行文件中

  1. //
  2. /* */
  3. /** */自动生成文档

2 注释的插入

javadoc 从下面几个特性中抽取信息:

3 类注释

类注释必须在 import 语句之后,在类定义之前。

4 方法注释

方法注释必须放在方法之前,除了通用标记之外,还可以使用 @param ,@return ,@throws 等描述:

5 域注释

只需要对公共域(常指静态常量)建议注释文档,其他域建立了文档会暴露信息。

6 通用注释

@author
@version
@since 始于
@deprecated 不再使用,给出取代建议
@see reference

7 包与概述注释

要想产生包注释,需要在每个包目录中添加一个单独的文件。两种方法:

  1. package.html 文件, body 中的内容会全部被提取出来。
  2. package-info.java 文件,使用 /* 和 / ,界定外不可以有其他代码。

8 注释的抽取

javadoc -d 目录 包名