Posted on 2007-10-22 16:47
G_G 阅读(925)
评论(0) 编辑 收藏 所属分类:
javaGeneral
1。项目中 ->Exprot.. -> @javadoc 就可以了
2。javadoc 命令学习
@author 作者
@see 另请参见
（1）、@see "string" 为"string"添加文本项，不产生链接。
（2）、@see <a href="URL#Value">Label</a> 使用HTML标记产生链接
（3）、@see package.class#member Label 使用Java语言的名字package.class #member产生链接。
@version 版
@since 从以下版本开
@param 参数说明
/** */中的开头是注解
- /**
*/ 的就近原则 在那个上面就为那个注解
参照：http://java.ccidnet.com/art/3743/20031203/519697_1.html
/** class description
*/
3、Variable Description:描述变量的意义和取值含义。
/** var variable description
*/
4、Method Description:标明每个方法的输入、输出参数和返回值类型，说明特殊变量取值的含义。相关类文档链接。
/** method description
* @param var signification 方法参数说明
* @exception exception class name throws 说明
* @return return_value return signification return 说明
*/
5、Association Description:关联类文档描述，在注释当中需要参引其它文档描述的地方，可在相应的注释当中如下插入：
/** method description
* @param var signification
* @exception exception class name
* @return return_value return signification
* @see package.class#member label
*/
6、包描述文件：概括描述包的功能和设计概要。为每个包创建一个描述文件，命名为package.html，与包的java文件放在一起。
-