码迷,mamicode.com
首页 > 编程语言 > 详细

JavaDoc生成文档

时间:2021-05-24 00:17:56      阅读:0      评论:0      收藏:0      [点我收藏+]

标签:参数   显示   end   lock   encoding   命令   htm   ide   string   

命令行 JavaDoc 生成文档

// 加在类上就是类注释 加在方法上面就是方法注释
// @author 作者名
// @version 版本号
// @since 指明需要最早使用的jdk版本
// @param 参数名
// @return 返回值情况
// @throws 异常抛出情况
/**
 * @author com.wg
 * @cersion 1.0
 * @since 1.8
 */
public class Doc {
    String name;

    /**
     * @author com.wg
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
    // 找到 Doc 文件位置 通过命令行生成//cmd F:\学习笔记\java\JavaSE\基础语法\src\com.wg\base
    //javadoc -encoding UTF-8 -charset UTF-8 Doc.java
    //点击index.html
}

1. 找到Doc文件位置 通过命令行生成

技术图片

 

 

2. 输入 javadoc -encoding UTF-8 -charset UTF-8 Doc.java 为了显示中文正常

 技术图片

3. 找到文件夹,点击index.html,就可以看到生成的API文档

 

 

 技术图片

 

 

技术图片

 

 

 

 

 

IDEA JavaDoc 生成文档

  1. 新建一个文件夹

    技术图片

  2. 接下来点击IDEA顶部的Tools菜单,选择Generate JavaDoc选项

    技术图片

  3. 选择路径,刚刚新建的文件夹,在红框里输入,然后点击ok

    zh_CN
    -encoding utf-8 -charset utf-8

    技术图片

  4. 等待生成文档,完成后打开JavaDoc文件夹,找到index.html,打开就能看到API文档

 

 

JavaDoc生成文档

标签:参数   显示   end   lock   encoding   命令   htm   ide   string   

原文地址:https://www.cnblogs.com/fiftycents/p/14737504.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!