如何用Idea生成JavaDoc文档

以下为示例代码:

package com.chen;
/**
 * @author chenshuang
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;
    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception {
        return name;
    }
}

参数信息:

  • @author 作者名

  • @version 版本号

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

  • @return参数名

  • @throws 异常抛出情况

步骤:

1、

2、

 

 注释:

1、选择是整个项目还是模块还是单个文件

2、文档输出路径

3、选择文档的语言,中文就是zh_CN

4、传入JavaDoc的参数,一般这样写:

-encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api


版权声明:本文为PIKapikaaaa原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。