2021-07-16

本文介绍了如何使用JavaDoc为Java代码创建自定义API文档,包括基本注解如@author、@version、@since,以及参数(@param)、返回值(@return)和异常处理(@throws)的使用示例。通过这个教程,开发者可以更好地组织和文档化其Java代码。
摘要由CSDN通过智能技术生成

Java学习笔记

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

参数信息

@author 作者名

@version 版本号

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

@param 参数名

@return 返回值情况

@throws 异常抛出情况

代码示例

package java基础;
/**
*@author zhangsan
*@version 1.0
*@since 1.8
 */

public class javaDoc
     {
        String name;

         /**
          * @author zhangsan
          * @param name
          * @return
          * @throws Exception
          */
        public String test (String name) throws Exception {
            return name;

    }
}

在这里插入图片描述

在这里插入图片描述

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值