Java认证:关于注释规范整理的讲解

来源:java认证发布时间:2012-11-12 13:16:19java认证视频

  3、构造函数注释:
  构造函数注释采用 /** …… */,描述部分注明构造函数的作用,不一定有块标记部分。
  注释模版一:
  /**
  * 默认构造函数
  */
  注释模版二:
  /**
  * Description :       带参数构造函数,
  *                       初始化模式名,名称和数据源类型
  * @param schema:   模式名
  * @param name:   名称
  * @param type: 数据源类型
  */
  4、函数注释:
  函数注释采用 /** ……*/,在每个函数或者过程的前面要有必要的注释信息,包括:函数或过程名称;功能描述;输入、输出及返回值说明;调用关系及被调用关系说明等。函数注释里面可以不出现版本号(@version)。
  注释模版一:
  /**
  * 函 数 名 :
  * 功能描述:
  * 输入参数:     <按照参数定义顺序>
  *             <@param后面空格后跟着参数的变量名字
  *            (不是类型),空格后跟着对该参数的描述。>
  *
  * 返 回 值:  - 类型 <说明>
  *            <返回为空(void)的构造函数或者函数,
  *            @return可以省略; 如果返回值就是输入参数,必须 *            用与输入参数的@param相同的描述信息; 必要的时*            候注明特殊条件写的返回值。>
  * 异    常:<按照异常名字的字母顺序>
  * 创 建 人:
  * 日    期:
  * 修 改 人:
  * 日    期:
  */
  注释模版二:
  /**
  * FunName:           getFirstSpell
  * Description :      获取汉字拼音首字母的字符串,
  *                   被生成百家姓函数调用
  * @param:         str the String是包含汉字的字符串
  * @return String:汉字返回拼音首字母字符串;
  *                  英文字母返回对应的大写字母;
  *                 其他非简体汉字返回 '0';
  * @Author:       ghc
  * @Create Date: 2008-07-02
  */
  5、方法注释:
  方法注释采用 /** …… */,对于设置 (Set 方法 ) 与获取 (Get 方法 ) 成员的方法,在成员变量已有说明的情况下,可以不加注释;普通成员方法要求说明完成什么功能,参数含义是什么且返回值什么;另外方法的创建时间必须注释清楚,为将来的维护和阅读提供宝贵线索。
  6、方法内部注释:
  控制结构,代码做了些什么以及为什么这样做,处理顺序等,特别是复杂的逻辑处理部分,要尽可能的给出详细的注释。
  7、 全局变量注释:
  要有较详细的注释,包括对其功能、取值范围、哪些函数或者过程存取以及存取时注意事项等的说明。
  8、局部(中间)变量注释:
  主要变量必须有注释,无特别意义的情况下可以不加注释。
  9、实参/参数注释:
  参数含义、及其它任何约束或前提条件。
  10、字段/属性注释: 字段描述,属性说明。
  11、常量:常量通常具有一定的实际意义,要定义相应说明。

  考试大温馨提示:本内容来源于网络,仅代表作者个人观点,与本站立场无关,仅供您学习交流使用。其中可能有部分文章经过多次转载而造成文章内容缺失、错误或文章作者不详等问题,请您谅解。如有侵犯您的权利,请联系我们,本站会立即予以处理。

上一页234下一页

视频学习

我考网版权与免责声明

① 凡本网注明稿件来源为"原创"的所有文字、图片和音视频稿件,版权均属本网所有。任何媒体、网站或个人转载、链接转贴或以其他方式复制发表时必须注明"稿件来源:我考网",违者本网将依法追究责任;

② 本网部分稿件来源于网络,任何单位或个人认为我考网发布的内容可能涉嫌侵犯其合法权益,应该及时向我考网书面反馈,并提供身份证明、权属证明及详细侵权情况证明,我考网在收到上述法律文件后,将会尽快移除被控侵权内容。

最近更新

社区交流

考试问答