黑马程序员:给class文件写说明书,java的说明说通过文档注释来完成

来源:互联网 发布:js控制disabled 编辑:程序博客网 时间:2024/04/29 19:33

---------------------- ASP.Net+Android+IOS开发、.Net培训、期待与您交流! ----------------------

给class文件写说明书,java的说明说通过文档注释来完成

/**
类的描述信息
@author 张三
@version V1.1
*/
每个public方法都写上类似如下说明: @param param是参数的意思
/**
获取一个整形数组中的最大值
@param arr 接收一个int类型的数组
@return 会返回一个数组中的最大值
*/


生成说明书的方法:  -d参数为directory 目录的意思
javadoc -d help -author -version ArrayTools.java


注意:要使用javadoc来生成说明书,被生成的java文件中的class必须被public修饰。

---------------------- ASP.Net+Android+IOS开发、.Net培训、期待与您交流! ----------------------详细请查看:http://edu.csdn.net

原创粉丝点击