java编码规范教材@v0.4.ppt

编码规范java AC 李军治 目 录 概述 文件体系结构 文件命名规则 排版规则 注释规则 java命名规则 EJB代码文件命名习惯 变量 方法 可读性 程序效率 质量保证 附录A 范围 范围 定义了编写Java代码时应遵守的规则和习惯。 提供编写Enterprise JavaBean代码的命名规则和习惯。 术语： 规则：强制必须遵守的原则。 建议：必须加以考虑的原则,无标注的视为建议 。 说明【 】：对规则或建议的必要解释。 示例：对规则或建议给出的例子。 目 录 概述 文件体系结构 文件命名规则 排版规则 注释规则 java命名规则 EJB代码文件命名习惯 变量 方法 可读性 程序效率 质量保证 附录A 2.1文件体系规则 规则-JSP文件目录结构 建议- Java文件目录结构 2.2源文件结构规则 规则--包和引入语句 先写包语句，再写引入语句。 package行和import行之间留一行空行。 引入的标准包名要在本地包名之前，并且包名按照字母顺序排列。 如果 import 行中包含了同一个包中的类超过5个，则用 * 来处理。 import的标准包和本地包之间留一行空行。 示例： … 规则-类/接口 先写类/接口注释，标明类/接口的用途、版本、作者等信息。 类/接口注释之后空一行，然后写类/接口声明。 extends 和 implements写在不同行。 … 规则-类变量的声明顺序是public,protected,package,private 规则-变量、常量的注释应放在其上方相邻位置或右方 规则-用递增的方式写构造器（比如：参数多的写在后面） 规则-类变量的存取方法：get和set方法 规则-如果定义main() 方法，必须将main方法写在类的底部 目 录 概述 文件体系结构 文件命名规则 排版规则 注释规则 java命名规则 EJB代码文件命名习惯 变量 方法 可读性 程序效率 质量保证 附录A 文件命名规则 规则-Structs配置文件命名 sc-模块名.xml 规则-JSP文件命名 规则- Java文件命名 目 录 概述 文件体系结构 文件命名规则 排版规则 注释规则 java命名规则 EJB代码文件命名习惯 变量 方法 可读性 程序效率 质量保证 附录A 4.1方法排版规则 规则-方法名和其后的括弧之间不应有空格 示例： int getResult(int forInt, char forChar) 规则- 缩进采用4个空格 注意：一定要使用空格键。这样可以避免使用不同的编辑器阅读程序时，因TAB键所设置的空格数目不同而造成程序布局不整齐。 规则-在方法的局部变量声明和其它语句之间加一个空行 4.2语句排版规则 规则-简单语句每行至多包含一条语句 规则-左大括号{应位于复合语句起始行的行尾；右大括号}应另起一行并与复合语句首行对齐。 规则- 必须用{和}将if内的语句括起来。(即使只有一条语句的情况下) … 规则-在多层嵌套的if语句中，需以尾端注释的方式表示出层次关系 规则- for语句中的表达式要用空格分开 示例： for (expr1; expr2; expr3) 规则- 在多层嵌套的for语句中，应以尾端注释的方式表示出层次关系 规则-每当一个case顺着往下执行时(因为没有break语句)，通常应在break语句的位置添加注释。下面的示例代码中就包含注释/* falls through */ 示例： … 建议-关键词for和后面的括号之间加一个空格 建议-关键词while和后面的括号之间加一个空格 建议-关键词switch和后面的括号之间加一个空格 建议-关键词catch和后面的括号之间加一个空格 4.3表达式排版规则 规则-左括号和后一个字符之间不应该出现空格, 同样, 右括号和前一个字符之间也不应该出现空格 规则-用空格分隔所有的二元运算符（除了.）和操作数 示例： 规则-一元操作符和操作数之间不加空格 一元操作符包括负号（-）、自增（++）、自减（--）。 示例： 规则-强制转型后要跟一个空格 示例： 建议4.3.6 单行不应超过80个字符 断行的原则是： 在逗号后。 在操作符前。 所断的行之间要对齐。 目 录 概述 文件体系结构 文件命名规则 排版规则 注释规则 java命名规则 EJB代码文件命名习惯 变量 方法 可读性 程序效率 质量保证 附录A 5.1类注释规则 规则- 使用JavaDoc，列出功能、版本信息、日期、作者和版权声明 示例：