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

编码规范java
AC 李军治
目录
概述
文件体系结构
文件命名规则
排版规则
注释规则
java命名规则
EJB代码文件命名习惯
变量
方法
可读性
程序效率
质量保证
附录A
范围
范围
定义了编写Java代码时应遵守的规则和习惯。
提供编写Enterprise JavaBean代码的命名规则和习惯。
术语:
规则:强制必须遵守的原则。
建议:必须加以考虑的原则,无标注的视为建议。
说明【】:对规则或建议的必要解释。
示例:对规则或建议给出的例子。

规则-JSP文件目录结构
|――cgi 存放cgi程序|――cgi-bin 存放cgi编译后的程序|――css 存放样式表
|――html 存放html文件
|――images 存放图片|――include 存放系统要引用的文件|――js 存放javascript脚本
|――ocx 存放ocx控件
|――page 存放JSP页面
|――WEB-INF WEB 配置文件,class 文件
建议- Java文件目录结构
|――<模块分类目录> 模块分类
|――action 存放action(控制层)文件
|――dao 存放dao(数据层)文件
|――form 存放form(展示层)文件
|――service 存放业务逻辑文件
|――vo 存放数据对象文件

规则--包和引入语句
先写包语句,再写引入语句。
package行和import行之间留一行空行。
引入的标准包名要在本地包名之前,并且包名按照字母顺序排列。
如果 import 行中包含了同一个包中的类超过5个,则用* 来处理。
import的标准包和本地包之间留一行空行。
示例:
.;
import .*;
import ;
import ;
.;
.;
…
规则-类/接口
先写类/接口注释,标明类/接口的用途、版本、作者等信息。
类/接口注释之后空一行,然后写类/接口声明。
extends 和 implements写在不同行。
/**
* ***@author Administrator
*
*类/接口声明
*/
public class test
extends FaultProcess {
}
…
规则-类变量的声明顺序是public,protected,package,private
规则-变量、常量的注释应放在其上方相邻位置或右方
规则-用递增的方式写构造器(比如:参数多的写在后面)
规则-类变量的存取方法:get和set方法
规则-如果定义main() 方法,必须将main方法写在类的底部