制作java文档说明书

阅读更多

 

 

Last modified：2013-04-09 23:39:58

**********************************

 

使用“/** …… */”文档注释进行注释；

在类定义前面常使用注解来说明这个类的功能，版本信息，

@author 作者

@version 版本

用在每个方法前注明方法的参数和返回值。

@param 参数 对参数进行描述；

@return 对返回值进行描述； 

注意：这个类一定要用public修饰。

API（帮助文件）应用程序编程接口文档：

运行指令：javadoc -d 文档的存储路径> -author -version ArrayTool.java

然后就会在当前目录下生成一个类似java API的文档！