内容发布更新时间 : 2024/6/5 22:24:38星期一 下面是文章的全部内容请认真阅读。

ARCH4样本程序开发规范

ARCH4开发小组 2007年5月

第 1 页 共 21 页

目录

1

前言 ................................................................................................................................................................... 3 1.1 文档编写目的 ................................................................................................................................... 3 1.2 文档适用范围 ................................................................................................................................... 3 1.3 修订历史 ........................................................................................................................................... 4 开发环境和配置 ............................................................................................................................................... 4 JAVA开发规范 ................................................................................................................................................. 4 3.1 命名规范 ........................................................................................................................................... 4

3.1.1 总命名规则 ............................................................................................................................... 4 3.1.2 目录命名规范 ........................................................................................................................... 6 3.1.3 文件命名规范 ........................................................................................................................... 7 3.1.4 Java属性命名规则 ................................................................................................................... 9 3.1.5 Java方法命名规则 ................................................................................................................... 9 3.1.6 词根表 ....................................................................................................................................... 9 3.2 子系统/模块规范 .............................................................................................................................. 9

3.2.1 子系统命名规范 ....................................................................................................................... 9 3.2.2 模块命名规范 ......................................................................................................................... 10 3.2.3 特殊模块 ................................................................................................................................. 10 3.3 WEB层规范 ................................................................................................................................... 10

3.3.1 命名规范 ................................................................................................................................. 10 3.3.2 类编程规范 ............................................................................................................................. 10 3.3.3 方法编程规范 ..........................................................................................................................11 3.4 业务层规范 ......................................................................................................................................11

3.4.1 命名规范 ..................................................................................................................................11 3.4.2 方法命名规范 ..........................................................................................................................11 3.4.3 类编程规范 ..............................................................................................................................11 3.4.4 方法编程规范 ......................................................................................................................... 12 3.5 POJO类规范 ................................................................................................................................... 12 实现高效Java编程规范的基础规则 ............................................................................................................ 12 4.1 避免使用NEW关键字来创建String对象 .................................................................................... 12 4.2 避免使用不必要的嵌套 ................................................................................................................. 13 4.3 避免在同一行声明不同类型的多个变量 ...................................................................................... 13 4.4 在每一行里写一条语句 ................................................................................................................. 13 4.5 不要使用不推荐的API .................................................................................................................. 14 4.6 为所有序列化的类创建一个'serialVersionUID' ............................................................................ 14 4.7 对于private常量的定义 ................................................................................................................ 14 4.8 避免把方法本地变量和参数定义成和类变量相同的名字 .......................................................... 14 4.9 数组的命名 ..................................................................................................................................... 15 4.10 版权信息 ......................................................................................................................................... 15 4.11 JDBC连接....................................................................................................................................... 15 4.12 在表示长整常量的时候，用L来代替l ....................................................................................... 16 4.13 JAVA注释 ....................................................................................................................................... 16 JSP/HTML开发规范 ...................................................................................................................................... 17 5.1 JSP/HTML编码规范 ...................................................................................................................... 17 5.2 JSP/HTML注释 .............................................................................................................................. 17

2 3

4

5

第 2 页 共 21 页

6

JAVASCRIPT开发规范 .................................................................................................................................. 18 6.1 Javascript库维护规则 .................................................................................................................... 18 6.2 命名规范 ......................................................................................................................................... 19 6.3 Javascript注释 ................................................................................................................................ 20

1 前言

本文档是《ARCH4样本程序开发规范》，文档讲述的内容要求所有开发人员必须遵守。 开发人员还需要查阅《ARCH4系统开发指南》。

参与项目开发的任何开发人员如果对本文档讲述的内容有疑问，在开发前请询问项目经理，不允许任何开发人员以任何理由违反本文档讲述的规范要求。

1.1 文档编写目的

规范开发思想，约束开发行为，明确开发纪律。 特别约定：

1. 本章规范中，我们用“subsystems”代表“各个子系统”。例如“subsystems的Action类”表述为

“各个子系统的Action类”。

2. 本章规范中，我们用“module”代表“模块”。例如“module的POJO类”表述为“模块的POJO

类”。

3. 本章规范中所有的英文单词都是严格遵守大小写的。

1.2 文档适用范围

本文档适用于使用ARCH4架构开发系统的项目组成员。下表是本文档对于项目组成员的最低要求程度：

项目组成员 项目经理 系统分析师（业务） 系统分析师（技术） 是否必读 ■是 □否 ■是 □否 ■是 □否 要求程度 □了解文档结构 ■明白文档内容 □透彻理解 ■了解文档结构 □明白文档内容 □透彻理解 □了解文档结构 □明白文档内容 ■透彻理解 第 3 页 共 21 页