使用IDEA生产JavaDoc文档

源代码

package com.*****.base;

//文档注解
/**
 * @Author intelliyu
 * @version 1.0     //版本
 * since 1.8        //指明需要最早使用的jdk版本
 *
 */
public class Doc {

    String name;

    // 写完下面的方法 /**回车   自动生成
    /**
     * @Author intelliyu
     * @param name          //参数名
     * @return              //返回值情况
     * @throws Exception    //抛出异常
     */
    public String test(String name) throws Exception{       //throws 抛出一个异常
        return name;
    }

    public static void main(String[] args){
        System.out.println("Hello World !");
    }
}

1.任意位置创建一个存放JavaDoc的文件夹

1

2.打开IDEA 依次按照图片所示顺寻操作

2
3
4

3.操作完点击完成OK 控制台会显示相关信息(有部分错误可忽略)

4.最后找到所创建的文件夹,打开index.html查看

5.完成!


作者:intelliyu
本文仅供娱乐学习交流,严禁使用于任何商业用途!
欢迎任何形式的转载,但请务必注明出处。
限于本人水平,如果内容有表述不当之处,还请不吝赐教。

posted @ 2022-01-16 20:55  intelliyu  阅读(72)  评论(0编辑  收藏  举报