第九章 Java编码规范.ppt

制定编码规范的最主要的目的是为了对产出代码的长期维护。通常负责 维护代码的人大多都不是开发者本人，如果有一个统一的代码格式以及 说明就可以减少混淆提高理解速度。 范围 编码规范定义了所有代码编写者在编写Java代码时应遵守的一些规 则和习惯。 本规范采用以下术语描述： 规则：编程时强制必须遵守的原则。 建议：编程时必须加以考虑的原则。 示例：对此规则或建议给出例子。 2.1 文件体系规则 规则2.1.1 JSP文件目录结构 |――cgi 存放cgi程序|――cgi-bin 存放cgi编译后的程序|――css 存放样式表 |――html 存放临时生成的报表文件|――images 存放图片|――include 存放系统要引用的文件|――js 存放javascript脚本 |――ocx 存放ocx控件 |――page 存放JSP页面|――模块分类名 |――WEB-INF WEB 配置文件，class 文件 2.1 文件体系规则 建议2.1.2 Java文件目录结构 |――模块分类目录 模块分类 |――action 存放action（控制层）文件 |――dao 存放dao（数据层）文件 |――form 存放form（展示层）文件 |――service 存放业务逻辑文件 |――vo 存放数据对象文件 2.2 源文件结构规则 规则2.2.1 包和引入语句 先写包语句，再写引入语句。 package行和import行之间留一行空行。 引入的标准包名要在本地包名之前，并且包名按照字母顺序排列。 如果 import 行中包含了同一个包中的类超过5个，则用 * 来处理。 import的标准包和本地包之间留一行空行。 示例： 2.2 源文件结构规则 规则2.2.2 类/接口 先写类/接口注释，标明类/接口的用途、版本、作者等信息。 类/接口注释之后空一行，然后写类/接口声明。 extends 和 implements写在不同行。 异常也单写一行。 示例： 2.2 源文件结构规则 规则2.2.3 类变量的声明顺序是 public,protected,package,private 公共变量（Public） 保护变量（Protected） 包一级别的变量（没有访问修饰符) 私有变量（Private） 2.2 源文件结构规则 规则2.2.4 变量、常量的注释应放在其上方相邻位置或右方 规则2.2.5 用递增的方式写构造器（比如：参数多的写在后面） 规则2.2.6 类变量的存取方法：get和set方法 规则2.2.7 如果定义main() 方法，必须将main方法写在类的底部 3.1 Struts配制文件命名 4.1 方法排版规则 规则4.1.1 方法名和其后的括弧之间不应有空格 示例： 4.1 方法排版规则 规则4.1.3 在方法的局部变量声明和语句之间加一个空行 示例： 4.1 方法排版规则 规则4.1.4 块注释或单行注释之前必须有一行空行 规则4.1.5 方法内的两个逻辑段之间必须有一行空行 建议4.1.6 在方法的每个参数之间的逗号后面加一个空格 4.2 语句排版规则 规则4.2.1 简单语句每行至多包含一条语句 示例： 4.2 语句排版规则 规则4.2.3 左大括号“{”应位于复合语句起始行的行尾；右大括号“}”应 另起一行并与复合语句首行对齐。 示例： 4.2 语句排版规则 规则4.2.4 必须用“{”和“}”将if内的语句括起来。(即使只有一条语句 的情况下) 正确： 4.2 语句排版规则 规则4.2.5 在多层嵌套的if语句中，需以尾端注释的方式表示出层次关系 4.2 语句排版规则 规则4.2.8 每当一个case顺着往下执行时(因为没有break语句)，通常 应在break语句的位置添加注释。下面的示例代码中就包含注释 /* falls through */ 示例： 4.2 语句排版规则 建议4.2.9 大括号可以被用于所有语句，包括单个语句，只要这些语句是诸如if-else或for控制结构的一部分 建议4.2.10 关键词for和后面的括号之间加一个空格 建议4.2.1