Java文档的简要介绍和快速生成

在开发中遇到问题，开发人员都是习惯性的去查阅相关手册，通俗来说就是注释文档。当我们在实际工作中封装了相关的函数方法，便于其他人使用则采用文档注释的方法。

要达成这种效果其实蛮简单的，利用java有自带的工具javadoc

先来写个小例子；

写好相关的工具类，并写好注释（注意：类的修饰符要用public 使用最大权限。且private修饰的方法无法注释）

@author 作者 @version 版本 @param 参数 @return 返回值

2.打开cmd窗口，找到classs文件路径，并输入相关执行参数

javadoc -d Mydoc -author -version ArrayTools.java (1.-d表示生成文件路径 2.Mydoc表示生成文档所在文件夹 3.-author作者 4.version版本 5.ArrayTools.java表示对该类进行文档注释)

3.执行完成效果如下 打开index.html：

这样完成后，其他开发人员想要使用你所写的方法就可以清晰的知道需要传哪些参数，返回什么值。当然这算是一种友好的行为。