Java 文档注释-JavaDoc

1 概述

javadoc 命令时用来生成自己API文档的

2 Java 命令生成 API文档

2.1 参数信息

 @author 作者名
 @version 版本号
 @since 指明需要最早使用的jdk版本
 @param 参数名
 @return 返回值情况
 @throws 异常抛出情况

2.2 测试代码

自动补全文档注释【快捷键】

1. 输入/**
2. 然后Enter

package com.kuang.base;

/**
 * @author Jerry
 * @version 1.0
 * @since 1.7
 * */
public class Doc {
    String name;

    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }

}

2.3 命令行生成 API 文档

# encoding 程序编码为UTF-8 ; charset 程序中的字符集编码为 UTF-8	-->解决乱码问题，中文不识别
# -d ./test //在当前目录下的tets文件夹生成 API 文档
javadoc -encoding UTF-8 -charset UTF-8 -d ./test 类名

3 IDE 生成 API 文档

1. Tools->Gerenate JavaDoc
2. Other command line arguments 栏里输入：-encoding utf-8 -charset utf-8

PS：javadoc命令运行时，默认用了gbk编码，为了不乱码，指定编码UTF-8。