026_生成自己项目的API文档
一、什么是API
API即Application Programming Interface的首字母缩写、应用程序编程接口。
二、常用的注释标签
在生成API之前我们需了解一下jdk为我们提供的几个注释标签
@Author 作者
@version 版本
@param 参数
@return 返回值的含义
@throws 抛出异常描述
@deprecated 废弃。建议用户不在使用该方法
三、如何生成自己项目的API
生成项目的API之前一定要使用文档注释、及/** 注释内容*/
a)右键单击项目,选中export
生成后的API文档截图如下:
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步