Arch样本程序开发规范重点.doc

ARCH4样本程序开发规范 ARCH4开发小组 2007年5月 目录 1 前言 2 1.1 文档编写目的 2 1.2 文档适用范围 2 1.3 修订历史 3 2 开发环境和配置 3 3 JAVA开发规范 3 3.1 命名规范 3 3.1.1 总命名规则 3 3.1.2 目录命名规范 5 3.1.3 文件命名规范 7 3.1.4 Java属性命名规则 8 3.1.5 Java方法命名规则 9 3.1.6 词根表 9 3.2 子系统/模块规范 9 3.2.1 子系统命名规范 9 3.2.2 模块命名规范 9 3.2.3 特殊模块 10 3.3 WEB层规范 10 3.3.1 命名规范 10 3.3.2 类编程规范 10 3.3.3 方法编程规范 10 3.4 业务层规范 11 3.4.1 命名规范 11 3.4.2 方法命名规范 11 3.4.3 类编程规范 11 3.4.4 方法编程规范 12 3.5 POJO类规范 12 4 实现高效Java编程规范的基础规则 12 4.1 避免使用NEW关键字来创建String对象 12 4.2 避免使用不必要的嵌套 12 4.3 避免在同一行声明不同类型的多个变量 13 4.4 在每一行里写一条语句 13 4.5 不要使用不推荐的API 13 4.6 为所有序列化的类创建一个serialVersionUID 13 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 5 JSP/HTML开发规范 17 5.1 JSP/HTML编码规范 17 5.2 JSP/HTML注释 17 6 JAVASCRIPT开发规范 18 6.1 Javascript库维护规则 18 6.2 命名规范 18 6.3 Javascript注释 20 前言 本文档是《ARCH4样本程序开发规范》，文档讲述的内容要求所有开发人员必须遵守。 开发人员还需要查阅《ARCH4系统开发指南》。 参与项目开发的任何开发人员如果对本文档讲述的内容有疑问，在开发前请询问项目经理，不允许任何开发人员以任何理由违反本文档讲述的规范要求。 文档编写目的 规范开发思想，约束开发行为，明确开发纪律。 特别约定： 本章规范中，我们用“subsystems”代表“各个子系统”。例如“subsystems的Action类”表述为“各个子系统的Action类”。 本章规范中，我们用“module”代表“模块”。例如“module的POJO类”表述为“模块的POJO类”。 本章规范中所有的英文单词都是严格遵守大小写的。 文档适用范围 本文档适用于使用ARCH4架构开发系统的项目组成员。下表是本文档对于项目组成员的最低要求程度： 项目组成员 是否必读 要求程度 项目经理 ■是 □否 □了解文档结构 ■明白文档内容 □透彻理解 系统分析师（业务） ■是 □否 ■了解文档结构 □明白文档内容 □透彻理解 系统分析师（技术） ■是 □否 □了解文档结构 □明白文档内容 ■透彻理解 高级程序员 ■是 □否 □了解文档结构 ■明白文档内容 □透彻理解 开发工程师 ■是 □否 □了解文档结构 ■明白文档内容 □透彻理解 质量保证工程师 □是 ■否 □了解文档结构 □明白文档内容 □透彻理解 对于项目经理、系统分析师、高级程序员和开发工程师，还需要阅读《ARCH4系统架构设计说明书》和《ARCH4系统开发指南》。 修订历史 修订章节 类型 日期 作者 说明 全部 创建 2007-05-16 周咸立 新建文档 修改 2007-05-30 周咸立 变更目录组织形式，将pages目录移至根目录 3 修改 2007-06-12 周咸立 添加Java类命名规则，Java类属性命名规则等，变更示例包名。 3 修改 2007-06-14 周咸立 添加Java方法命名规则。 开发环境和配置 必须遵守《ARCH4开发环境搭建指南》的讲述。 JAVA开发规范 命名 总命名规则 概述 典型环境名 Java Struts2Action对象 Service Java Service的接口 ServiceSpringImpl Java Service的Spring方式实现 典型对象名 保单 PrpDuser 物理表名 员工 Claim 业务对象 立案 User 业务对象 员工 Main 表名 主表 Head 布局名 头部 Middle 布局名 中部 Tail 布局名 尾部 典型操作名 操作名 适用文件类型 含义 Edit J