【Java重新学习】Java面向对象-Javadoc文档注释

Javadoc，由源文件生成一个html文档。

通过界定符/** 开始注释。

Javadoc从以下几个方面抽取信息：

包，公有类与接口，公有的和受保护的方法，公有的和受保护的域。

每个/** */文档注释在标记之后（@标记）跟着自由文本格式。

方法注释：每一个方法注释放在方法前，除了通用标记，还推荐使用一下标记

@param variable description

对参数部分进行描述

@return description

对返回值进行描述

@throws class description

表示这个方法可能抛出的异常。

域注释：对公有域（静态常量）建立文档。

通用注释：

@author name 作者姓名

@version text 版本号

@since next对引入特性的版本进行描述

@deprecated text         对类、方法或变量添加一个不再使用的注释。通过@see和@link，使用超链接，连接到javadoc文档。

@see reference 建立一个超链接

包与概述注释：在每一个包目录中添加一个单独文件。

注释的抽取：

1、 切换到包含要生成文档的源文件的目录。

2、 如果是一个包，应该运行命令：

Javadoc –d docDir nameOfPackage

Javadoc –link …… 为标准类添加超链接。所有的标准类库都会自动地连接到官方文档。

http://docs.oracle.com/javase/7/docs/api/

 

Tip：定制文档，可用doclet