javaDoc用来生成自己的API文档

最新推荐文章于 2024-08-12 20:46:24 发布

handsome_confide

最新推荐文章于 2024-08-12 20:46:24 发布

阅读量242

点赞数

文章标签： java jvm 开发语言

版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文链接：https://blog.csdn.net/handsome_confide/article/details/126803717

版权

本文档介绍了如何使用JavaDoc工具来创建自定义的API文档。通过在代码中添加特定的注释，如@author, @version, @since, @param, @return和@throws，然后在终端运行JavaDoc命令，可以生成详细的API文档。这个过程包括了从在源代码中插入注释，到在终端执行生成命令，最后查看生成的HTML文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

JavaDoc

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

创建自己的doc
```
package com.wang.basics;

/**
 * @author wang
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    /**
     * @param name
     * @return
     * @throws Exception
     */
    public String name(String name)throws Exception{
        return name;
    }


}
```
Doc类所在Finder中的位置

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-RRfMhvw8-1662866834

328)(JavaDoc.assets/image-20220911112151243.png)]

在终端中先进入Doc.java文件夹

输入命令生成自己的API
- [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-iLuugbjS-1662866834330)(JavaDoc.assets/image-20220911111922024.png)]

在Doc类文件中会生成很多文件，双击index.html

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Z8fT4oe3-1662866834330)(JavaDoc.assets/image-20220911112407137.png)]

成功生成自己的api文档

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-oS3SuMBN-1662866834331)(JavaDoc.assets/image-20220911112614733.png)]

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

评论

被折叠的条评论为什么被折叠?

到【灌水乐园】发言

查看更多评论

添加红包

成就一亿技术人!

hope_wisdom

发出的红包

实付元

使用余额支付

点击重新获取

扫码支付

钱包余额 0

抵扣说明：

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