15.JavaDoc

这篇博客详细介绍了如何使用Javadoc命令来生成Java API文档。内容包括@author、@version、@since、@param、@return和@throws等注释标签的用法。示例代码展示了在命令行和IDEA中生成JavaDoc文件的步骤,帮助开发者更好地管理和分享自己的代码接口信息。
摘要由CSDN通过智能技术生成

javadoc命令是用来完成自己API文档的

参数信息

  • @author 作者名
  • @version 版本号
  • @since 指明需要早期使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况
/**
 *@author 枭紫兮
 *@version 1.0
 *@since 1.8
 */
public class Doc {

    String name;

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

        //生成JavaDoc文件:
        //①通过命令行实现:javadoc 参数 Java文件   如:E:\CODE\JavaSE\基础语法\src\com\teamscorpionhome\base>javadoc -encoding UTF-8 -charset UTF-8 Doc.java
        //②通过IDEA产生JavaDoc文档    参考:https://blog.csdn.net/qq_42498502/article/details/90078972

    }

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

魔蝎之家

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值