Java文档注释小结

使用JDK中的javadoc可以有源文件生成一个HTML文档。这种注释会更专业，并且由于注释和代码在同一个文件里，因此可以保证每次修改后，保证代码和注释的一致性。

javadoc可从下面几个特性中抽取信息：
- 包
- 公有类与接口
- 公有的和受保护的构造器及方法
- 公有的和受保护的域

1、类注释

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

import com.sun.org.glassfish.gmbal.ParameterNames;

import java.lang.reflect.Array;
import java.util.*;

/**
 * Created by 95112 on 2/26/2018.
 */
public class LostInTheCity {
    public static void main(String[] args){
        }
 }    

2.方法注释

• @param变量描述
  对当前方法的参数进行描述，可以使用HTML标记
• @return返回描述
  对当前方法的返回进行描述
• @throws类描述
  对当前方法的异常进行描述

3.域注释

只需要对公有域即静态常量建立文档。如：

  /**
     *  The "i" is a test nnumber
     */
    static int i = 3;

4.通用注释

• @author（作者）姓名
• @version（版本）文本
• @since(始于）文本
• @deprecated(不建议再使用）文本
• @see（添加超链接）引用
  例如：

@see <a href="www.information.com/info.html">The information</a>

5.包注释

要产生包注释有两个方法：

方法一

提供一个package.html命名的HTML文件。按HTML语法编写注释

方法二

提供一个以package-info.java命名的Java文件。
该文件跟随一个
/**

*/
在包语句之后。

6.注释的抽取

6.1生成包的文档

切换到包含该包的目录，执行命令:

javadoc -d docDirectory nameOfPackage

或对于多个包生成文档：

javadoc -d docDirectory p1 p2 p3

如果文件在默认包中，就运行：

javadoc -d docDirectory *.java