/** * @(#)demo.java 1.00 2002/05/27 * * Copyright (c) 2000-2002 中国平安保险股份有限公司 版权所有 * Ping An Insurance Company of China. All rights reserved.
* This software is the confidential and proprietary * information of Ping An Insurance Company of China. * (Confidential Information). You shall not disclose * such Confidential Information and shall use it only * in accordance with the terms of the contract agreement * you entered into with Ping An. */
2、class description:类信息,概括的描述类的功能和实现。 /** class description */ 3、Variable Description:描述变量的意义和取值含义。 /** var variable description */ 4、Method Description:标明每个方法的输入、输出参数和返回值类型,说明特殊变量取值的含义。相关类文档链接。 /** method description * @param var signification * @exception exception class name * @return return_value return signification */
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文件放在一起。 注:javadoc生成文档时,会将该html文件的第一句放在package summary中,而把整个内容放在Overview summary中.
Copyright 2001-2010, www.comprg.com.cn, All Rights Reserved 京ICP备14022230号-1,电话/传真:010-82561037 82561614 ,Mail:gaojian@comprg.com.cn
地址:北京市海淀区远大路20号宝蓝大厦E座704,邮编:100089