文档下载 文档下载导航
设为首页 | 加入收藏
搜索 请输入内容:  
 导航当前位置: 文档下载 > 所有分类 > IT/计算机 > 计算机软件及应用 > Java注释规范
侵权投诉

Java注释规范

Java注释规范,很详细,很有用。

1、 一般概念

1、注释应该增加代码的清晰度

2、保持注释的简洁

3、在写代码之前或同时写注释

4、注释出为什么做了一些事,而不仅仅是做了什么

2、 注释哪些部分

1、Java 文件:必须写明版权信息以及该文件的创建时间和作者;

2、类:类的目的、即类所完成的功能,以及该类创建的时间和作者名称;多人一次编辑或修改同一个类时,应在作者名称处出现多人的名称;

3、接口: 在满足类注释的基础之上,接口注释应该包含设置接口的目的、它应如何被使用以及如何不被使用。在接口注释清楚的前提下对应的实现类可以不加注释;

4、方法注释: 对于设置 (Set 方法 ) 与获取 (Get 方法 ) 成员的方法,在成员变量已有说明的情况下, 可以不加注释;普通成员方法要求说明完成什么功能,参数含义是什么且返回值什么;另外方法的创建时间必须注释清楚,为将来的维护和阅读提供宝贵线索;

5、方法内部注释: 控制结构,代码做了些什么以及为什么这样做,处理顺序等,特别是复杂的逻辑处理部分,要尽可能的给出详细的注释;

6、参数: 参数含义、及其它任何约束或前提条件;

7、属性: 字段描述;

8、局部 ( 中间 ) 变量: 无特别意义的情况下不加注释;

3、注释格式

遵循工程规定的统一注释格式,一般情况下会以 codetemplates.xml 格式的文件导入 IDE(Eclipse)或者用Eclipse默认的;

四、代码格式规范

遵循工程规定的统一代码格式,一般情况下直接使用 IDE(Eclipse) 自带的默认代码格式对代码进行格式化;

1、单行(single-line)--短注释://……

单独行注释:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。

注释格式:/* 注释内容 */

上一页第3页

热门文档

相关文档

  • Java注释规范整理

    Java注释规范整理_IT/计算机_专业资料。Java注释规范Java 注释规范一、背景 1、当我们第一次接触某段代码,但又被要求在极短的时间内有效地分 析这段代码,我们...

  • java注释书写规范

    java注释书写规范_IT/计算机_专业资料。Java 注释书写规范 Javadoc 是 Sun 公司提供的一个技术,它从程序源代码中抽取类、方法、成 员等注释形成一个和源代码...

  • java注释规范

    java注释规范_IT/计算机_专业资料。javadoc 做注释 一. Java 文档 // 注释一行 /* ... */ 注释若干行 /** ... */ 注释若干行,并写入 javadoc 文档...

  • java注释规范

    java注释规范_IT/计算机_专业资料。JAVA注释规范设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开 Comments 节点就是所有需设置...

  • Java注释规范

    Java注释规范_电子/电路_工程科技_专业资料。Java的各种注释,以及写入Javadoc的注释要求对于Java 注释我们主要了解两种: // 注释一行 /* ... */ 注释若干行...

  • java注释规范

    java注释规范_工学_高等教育_教育专区。Java 程序有两类注释:实现注释(implementation comments)和文档注释(document comments)。 实现注释:/*…*/和//,用以注释...

  • java中的注释规范

    java中的注释规范_IT/计算机_专业资料。java中的注释规范JAVA 注释方法及格式 1、单行(single-line)--短注释://…… 单独行注释:在代码中单起一行注释, 注释...

  • javadoc注释规范

    javadoc注释规范_专业资料。javadoc注释规范javadoc 做注释 一. Java 文档 // 注释一行 注释若干行 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法...

  • 注释模板规范_java

    注释模板规范_java_计算机软件及应用_IT/计算机_专业资料。关于java注释模板规范设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后...

站点地图 | 文档上传 | 侵权投诉 | 手机版
本站所有资源均来自互联网,本站只负责收集和整理,均不承担任何法律责任,如有侵权等其它行为请联系我们.
文档下载 Copyright 2013 doc.guandang.net All Rights Reserved.  -  email