Java 生成doc文档

最新推荐文章于 2024-08-26 22:15:00 发布

李彦庆

最新推荐文章于 2024-08-26 22:15:00 发布

阅读量359

点赞数

分类专栏：李彦庆的java之路文章标签： java

本文链接：https://blog.csdn.net/qq_47381208/article/details/127627631

版权

李彦庆的java之路专栏收录该内容

12 篇文章 0 订阅

订阅专栏

我们可以通过文档注释( /** */ )，来生成我们自己写的代码的文档

javadoc -encoding UTF-8(设置编码) -charset UTF-8(设置字符集编码) 文件名称

下面是常用的参数和参数代表的意思

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

下面来看一段完整的可生成的代码

/**
 * @author 李彦庆
 * @version 1.0
 * @since 1.8
 */

public class doc {

    String name = "李彦庆";
    byte age;
    byte height;

    /**
     *
     * @param names
     * @return name
     */
    public String getName(String names){
        return name;
    }

    /**
     *
     * @return age
     */
    public byte getAge(){
        return age;
    }

    /**
     *
     * @return height
     */
    public byte getHeight(){
        return height;
    }

}

此时在小黑框中使用文档最开始的命令即可生成对应的文档