JavaDoc文档的介绍及生成方法

javaDoc命令是用来生成自己的API文档的

参数信息
  1. @author 作者名
  2. @version 版本号
  3. @since 指明需要最早使用的jdk版本
  4. @param 参数名
  5. @return 返回值情况
  6. @throws 异常抛出情况
package base;

/**
 * @autor yeyue
 * @version 1.o
 * @since 1.8
 */
public class Doc {

    String name;

    /**
     * @autor yeyue
     * @param name
     * @return
     * @throws Exception
     */

    public String test(String name) throws Exception{
        return name;
    }
}

命令生成DOC文档

javadoc -encoding UTF-8 -charset UTF-8 java类名称

IDEA生成DOC文档
  1. 找到工具菜单

在这里插入图片描述

  1. 配置号输出的目录和字符集(为了更好的适配中文),直接点OK即可。

在这里插入图片描述

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值