JavaDoc用法

JavaDoc用法

参数信息

@author 作者

@version 版本号

@since 指明需要最早使用的jdk版本

@param 参数名

@return 返回值情况

@throws 异常抛出情况

如何导出doc文档

例如：有如下类

public class Doc {

    /**
     * @author zhang
     * @version 1.0
     * @since 1.8
     * @param name
     * @return
     */
    public String test (String name){

        return  name;
    }
}

导出一 命令行导出

右键想要打包的文件-show in explorer - 在打开的地址栏中 前加上cmd和空格-在弹出框输入

javadoc -encoding utf-8 -charset utf-8 Doc.java

此方法会在Doc.java的目录下生成文件（不太推荐）

导出二 idea导出

1. 点击Tools–Generate JavaDoc ,出现配置页面
2. 进行配置