JAV开发编码规范.docVIP

JAVA开发编码规范 版 本 说 明 版本 制订人 制订日期 主要内容 V1.0 夏霆 2008-09-11 JAVA开发编码规范初稿 V1.1 田路 2008-10-31 JAVA开发编码规范修改 V1.2 夏霆 2008-10-31 确认发布 一、 前言 3 1.1、 目的 3 1.2、范围 4 二、 格式规范 4 2.1 缩进 5 2.2 换行 5 2.3 间隔 5 2.4 对齐 5 2.5 括号 5 三、注释规范 6 3.1 基本原则 6 3.2 文件注释 6 3.3 Java Doc 注释 6 3.4 失效代码注释 7 3.5 代码细节注释 7 3.6 注释的格式 8 3.7 注释的内容 8 3.8 Null 规约 8 4 命名规范(Naming Conventions) 9 4.1 基本约定 10 4.2 文件、包 10 4.3 类、接口 10 4.4 字段 10 5 编程规范(Programming Conventions) 11 5.1 基本规范 11 5.2 类与接口 12 5.3 方法 12 5.4 错误与异常 13 5.5 JDK5.0 及后续版本 14 5.6 性能与安全 14 6 自动代码检查和修正 15 6.1 为了编码的一致性，统一将Workspace中的编码方式设置为UTF-8编码 15 6.2使用统一的代码模板 16 前言 目的 本规范的目的是通过建立编码规范统一每个开发人员的编码习惯，提高程序的可靠性、可读性、可修改性、可维护性及一致性，增加团队合作开发效率，为各项目组之间或项目组内成员之间的技术交流提供一个方便统一的方式。 1.2、范围 本规范适用于公司内所有运用JAVA技术的软件项目、产品等的设计、开发以及维护、升级等。 本规范适用于公司所有JAVA软件开发人员。 本规范建议的开发环境与工具如下： IDE:Eclipse3.3.2以后版本 插件:MyEclipse6.0以后版本 JDK: Sun JDK 1.5 格式规范 对于代码，首要要求是它必须正确，能够按照设计预定功能去运行；第二是要求代码必须清晰易懂，使软件开发团队中的程序员能够很容易地理解代码。 代码的组织和风格的基本原则是：便于自己的开发，易于与他人的交流。 因个人习惯和编辑器等可以设置和形成自己的风格，但必须前后一致，并符合本规范的基本要求和原则。 2.1 缩进 使用TAB 缩进，而不是空格键——将缩进2，4，8 字符的选择权留给阅读者。 子功能块当在其父功能块后缩进。当功能块过多而导致缩进过深时当将子功能块提取出来做为子函数。 2.2 换行 页宽应该设置为80 字符。一般不要超过这个宽度, 这会导致在某些机器中或打印（A4）时无法以一屏来完整显示, 但这一设置也可以灵活调整。在任何情况下, 超长的语句应该在一个逗号后或一个操作符。 前折行。一条语句折行后, 应该比原来的语句再缩进一个TAB，以便于阅读。 2.3 间隔 类、方法及功能块间等应以空行相隔，以增加可读性，但不得有无规则的大片空行。操作符两端应当各空一个字符以增加可读性。相应独立的功能模块之间可使用注释行间隔，并标明相应内容。 2.4 对齐 关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。连续赋值时应当对齐操作符。当方法参数过多时在适当的参数后（逗号后）换行并对齐。当控制或循环中的条件比较长时当换行（操作符前）、对齐并注释各条件。 2.5 括号 括号中的语句应该单独作为一行，左括号{当紧跟其语句后，右括号}永远单独作为一行且与其匹配行对齐，并尽量在其后说明其匹配的功能模块。 较长的方法以及类、接口等的右括号后应使用//end ...等标识其结束。如: 类的结束符：}//end ClassName， 方法结束符：}//end methodName()， 功能块结束：}//end if...userName is null? 循环快结束：}//end for...every user in userList 不要在程序中出现不必要的括号，但有时为了增加可读性和便于理解，当用括号限定相应项。 If，for，while 语句只有单句时，如果该句可能引起阅读混淆，需要用{和}括起来，否则可以省略。 三、注释规范 3.1 基本原则 基本原则：注释应该增加代码的清晰度。代码注释的目的是要使代码更易于被其他开发人员等理解。 注释信息不仅要包括代码的功能，还应给出原因。 除变量定义等较短语句的注释可用行尾注释外，其他注释当避免使用行尾注释。 3.2 文件注释 在每个文件、包的头部都应该包含该文件的功能、作用、作者、版权以及创建、修改记录等。并在其中使用版本仓库标记自动跟踪版本变化及修改记录等信息。注意是标准的C-Style/*...*/ 注释而