026_生成自己项目的API文档

一、什么是API

　　API即Application Programming Interface的首字母缩写、应用程序编程接口。

二、常用的注释标签

　　在生成API之前我们需了解一下jdk为我们提供的几个注释标签

　　　　@Author 作者

　　　　@version 版本

　　　　@param  参数

　　　　@return  返回值的含义

　　　　@throws 抛出异常描述

　　　　@deprecated 废弃。建议用户不在使用该方法

三、如何生成自己项目的API

　　生成项目的API之前一定要使用文档注释、及/** 注释内容*/

　　a)右键单击项目，选中export

　　　　

生成后的API文档截图如下:

　　

 

转载于:https://www.cnblogs.com/aeon/p/9932965.html