您的位置:首页 > 职场人生

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

2013-10-21 14:55 363 查看
----------------------
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
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: