java中我们如何制作我们自己的API帮助文档

来源：互联网 2023-03-17 00:12:09 版权归原作者所有，如有侵权，请联系我们

什么叫API，它的全名是Application Programming Interface应用编程适配器，是语言、框架以及类库对外提供的编码的适配器。

当我们编写一个功能并定义API帮助文档话，可以更方便开发人员的使用，从而提高别的开发者编码的效率。

工具/原料

JAVASE

方法/步骤

首先我们要清楚源码注释规范，所需使用特殊的注释是/**填写功能内容*/。注释上可以添加我们所需的特殊内容。例如：@author author_name（作者）、@version（版本）、@param variable_name（参数）、@return description（方法的返回值）。想了解更多javadoc 标记，建意在CSDN博客找。

java中我们如何制作我们自己的API帮助文档