j2ee项目开发编码规范.doc

广州市亿讯软件开发有限公司 广州市亿讯软件开发有限公司 第 PAGE 8 页 共 NUMPAGES 68 页 J2EE软件编码原则 编写人：王德荣 2008 文档修订历史 版本号 版本日期 修订内容 修订人 0.1 2008.10.20 创建文档 王德荣 审批 本文档需要如下批示。 姓名 签名 日期 分发 文档已分发到下列人员 姓名 职务 参考的文档及资料 序号 参考资料名称 作者 版本 日期 目 录 TOC \o 1-3 \h \z \u 1 前言 7 2 总则 7 2.1目录结构 7 2.1.1总体目录结构说明 7 2.1.2源代码目录说明 8 2.1.3测试代码目录结构说明 9 2.1.4 JSP页面目录说明 10 3 java编码规范 10 3.1版本号定义 10 3.2文件名(File Names) 12 3.2.1 文件后缀(File Suffixes) 12 3.2.2 常用文件名(Common File Names) 12 3.3文件组织(File Organization) 12 3.3.1 Java源文件(Java Source Files) 12 3.4缩进排版(Indentation) 15 3.4.1 行长度(Line Length) 15 3.4.2 换行(Wrapping Lines) 16 3.5注释(Comments) 18 3.5.1 实现注释的格式(Implementation Comment Formats) 19 3.5.2 文档注释(Documentation Comments) 22 3.6声明(Declarations) 23 3.6.1 每行声明变量的数量(Number Per Line) 23 3.6.2 初始化(Initialization) 23 3.6.3 布局(Placement) 24 3.6.4 类和接口的声明(Class and Interface Declarations) 25 3.7语句(Statements) 26 3.7.1 简单语句(Simple Statements) 26 3.7.2 复合语句(Compound Statements) 26 3.7.3 返回语句(return Statements) 26 3.7.4 if，if-else，if else-if else语句 27 3.7.5 for语句(for Statements) 27 3.7.6 while语句(while Statements) 28 3.7.7 do-while语句(do-while Statements) 28 3.7.8 switch语句(switch Statements) 29 3.7.9 try-catch语句(try-catch Statements) 29 3.8空白(White Space) 30 3.8.1 空行(Blank Lines) 30 3.8.2 空格(Blank Spaces) 31 3.9命名规范(Naming Conventions) 32 3.10编程惯例(Programming Practices) 33 3.10.1 提供对实例以及类变量的访问控制(Providing Access to Instance and Class Variables) 33 3.10.2 引用类变量和类方法(Referring to Class Variables and Methods) 34 3.10.3 常量(Constants) 34 3.10.4 变量赋值(Variable Assignments) 34 3.10.5 其它惯例(Miscellaneous Practices) 35 3.11代码范例(Code Examples) 37 4 O/R mapping层规范 39 5 业务逻辑层编码规范 39 6 视图层编码规范 40