A股上市公司传智教育(股票代码 003032)旗下技术交流社区北京昌平校区

 找回密码
 加入黑马

QQ登录

只需一步,快速开始

© 李宗玛 中级黑马   /  2014-7-11 12:00  /  1350 人查看  /  3 人回复  /   0 人收藏 转载请遵从CC协议 禁止商业使用本文

将工具类发给别人使用,其他人只要将该文件设置在classpath路径下,就可以使用该工具类。该类到底定义了多少个方法,对方不清楚,于是应该制作该类的使用说明书。通过文档注释来完成。即 : /**...*/  @可以被java文档注释机制所识别。如@author  张三  而该类必须是public的    dos下生成文档(api)方法:javadoc  -d 保存路径 +要注明的信息,如作者和版本号  +类名.java   文档中只会提取暴露的,private修饰的不会提取  public修饰的会提取,一个类中默认会有一个空参数的构造函数,这个默认的构造函数和所属类一致。如果类被public修饰,那么默认的构造函数也是public,如果该类没有public修饰,那么默认构造函数也没有public修饰

3 个回复

倒序浏览
本帖最后由 David.L 于 2014-7-11 12:42 编辑

javadoc  -d 【保存路径】 @author @version 【类名】.java

* -d代表空格后为保存路径;【】是代表实际路径内容,不必输入; 保存路径如果没有盘符就是相对路径,有盘符就是绝对路径
* @author  @version 代表作者和版本,可自行选择是否添加,固定内容,其内容会读取文件中的对应的注释
好像应该是这样,看了毕老师视频,还是说 @author  @version可以直接换成具体内容?
回复 使用道具 举报
David.L 发表于 2014-7-11 12:41
javadoc  -d 【保存路径】 @author @version 【类名】.java

* -d代表空格后为保存路径;【】是代表实际路 ...

应该是换成具体作者和版本号   要不然写作者和版本号就没多大意义了
回复 使用道具 举报
李宗玛 发表于 2014-7-11 17:28
应该是换成具体作者和版本号   要不然写作者和版本号就没多大意义了

直接在/**...*/里面注释,运行时只要我那样就可以
可以参考毕老师视频,在/**...*/里面注释,更好一些
回复 使用道具 举报
您需要登录后才可以回帖 登录 | 加入黑马