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

什么叫做API帮助文档？

Application Programming Interface应用编程适配器，语言、框架以及类库对外提供的编码的适配器。

API帮助文档有什么用？

java有自己的官方的API帮助文档，就是很多官方的介绍和类、方法、变量的解释。一般很系统，涉及所有的方面，如果开发人员对正在使用的类不熟悉，想查看类里面的变量或者方法，就可以打开JavaAPI文档进行阅读和查看。可以让开发人员迅速的得到自己想要的系统的方法。

为什么定义帮助文档？

当我们写了一个功能给别的开发者使用的话。我们定义帮助文档就会让别人更好的了解你写的代码。这样可以帮助别人使用的我们写的功能的时候可以快速的提升他写代码的能力。

怎样定义帮助文档？

图1

首先我们定义一个我们需要的功能点的类，我们对这个类的每一个属性和方法写了注释，向图1我们对方法写的注释我们在调用的时候，会提示我们这个方法的作用和参数以及返回值。那我们要如何将这个类转化为API帮助文档呢？分为以下几步：

第一步

1、进入文件所在位置

第二步

第二步：利用javadoc 文件名或者是文件夹的名生成有关的html文件。

第三步

这样生成了一个HTML文件

图二

这就是我们生成API文档了。