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

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

  四、JAVA注释技巧
  1、空行和空白字符也是一种特殊注释。利用缩进和空行,使代码与注释容易区
  别,并协调美观。
  2、当代码比较长,特别是有多重嵌套时,为了使层次清晰,应当在一些段落的
  结束处加注释(在闭合的右花括号后注释该闭合所对应的起点),注释不能
  写得很长,只要能表示是哪个控制语句控制范围的结束即可,这样便于阅读。
  3、将注释与注释分隔符用一个空格分开,在没有颜色提示的情况下查看注释时,
  这样做会使注释很明显且容易被找到。
  4、不允许给块注释的周围加上外框。这样看起来可能很漂亮,但是难于维护。
  5、每行注释(连同代码)不要超过120个字(1024×768),最好不要超过80
  字(800×600) 。
  6、Java编辑器(IDE)注释快捷方式。Ctrl+/ 注释当前行,再按则取消注释。
  7、对于多行代码的注释,尽量不采用“/*......*/”,而采用多行“//”注释,
  这样虽然麻烦,但是在做屏蔽调试时不用查找配对的“/*......*/”。
  8、注释作为代码切换开关,用于临时测试屏蔽某些代码。
  例一:
  //*/
  codeSegement1;
  //*/
  改动第一行就成了:
  /*/
  codeSegement1;
  //*/
  例二:
  //----------------------第一段有效,第二段被注释
  //*/
  codeSegement1;
  /*/
  codeSegement2;
  //*/
  只需删除第一行的/就可以变成:
  //----------------------第一段被注释,第二段有效
  /*/
  codeSegement1;
  /*/
  codeSegement2;
  //*/
  五、JAVA注释方法及格式
  1、单行(single-line)--短注释://……
  单独行注释:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。
  注释格式:/* 注释内容 */
  行头注释:在代码行的开头进行注释。主要为了使该行代码失去意义。
  注释格式:// 注释内容
  行尾注释:尾端(trailing)--极短的注释,在代码行的行尾进行注释。一般与代码行后空8(至少4)个格,所有注释必须对齐。
  注释格式:代码 + 8(至少4)个空格 + // 注释内容
  2、块(block)--块注释:/*……*/
  注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述。一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成:
  /*
  * 注释内容
  */
  3、文档注释:/**……*/
  注释若干行,并写入javadoc文档。每个文档注释都会被置于注释定界符
  /**......*/之中,注释文档将用来生成HTML格式的代码报告,所以注释文

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

视频学习

我考网版权与免责声明

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

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

最近更新

社区交流

考试问答