帮助文档生成

1.工具类已经准备好了, 编译之后会形成ArrayTool.class文件, 如果我们把ArrayTool.class给你,就可以运行这个类型功能, 但是.class是看不懂. 又不想让你看原码, 还想让你用, 只能回ArrayTool工具类型提供一个帮助文档,就相当于工具类的使用说明书.

2.如何制作帮助文档:

要在被生成帮助文档的类的源文件,添加文档注释.

1.文档注释格式:

/**

  文档注释内容  不能嵌套

*/

3.帮助文档的注解:  将来可以把注解后的内容按照帮助文档格式生成.

      作者: @author lgx

      版本:@version  2.0

      从那个版本开始: @since 1.0

      参数: @param 参数名  参数名的含义

      返回值: @return  返回值内容解释

4.帮助文档的生成:

使用时jdk中bin文件夹下的指令javadoc来生成帮助文档

javadoc  -d  帮助文档生成后文件夹名称 -author  -version  源文件的路径

javadoc -d  ArrayToolDoc  -author -verson ArrayTool.java