Arch4系统开发指南-开发规范篇 中科软科技股份有限公司
Arch4系统开发指南-开发规范篇
技术平台组
第 1 页 共 20 页
Arch4系统开发指南-开发规范篇 中科软科技股份有限公司
目 录
1
前言 ................................................................................................................................................................... 4 1.1 文档编写目的 ................................................................................................................................... 4 1.2 文档适用范围 ................................................................................................................................... 4 1.3 修订历史 ........................................................................................................................................... 4 开发规范目标 ................................................................................................................................................... 5 命名规范 ........................................................................................................................................................... 5 3.1 总命名规则 ....................................................................................................................................... 5
3.1.1 概述 ........................................................................................................................................... 5 3.1.2 典型环境名 ............................................................................................................................... 5 3.1.3 典型对象名 ............................................................................................................................... 5 3.1.4 典型操作名 ............................................................................................................................... 6 3.1.5 举例 ........................................................................................................................................... 6 3.2 目录命名规范 ................................................................................................................................... 7
3.2.1 页面目录命名规则 ................................................................................................................... 7 3.2.2 Java程序目录结构 ................................................................................................................... 8 5.1 文件命名规范 ................................................................................................................................... 9
5.1.1 页面文件（表单）命名规则 ................................................................................................... 9 5.1.2 页面片段文件（表单）命名规则............................................................................................ 9 5.1.3 Java文件命名规则 ................................................................................................................... 9 5.2 Java程序命名规范 ........................................................................................................................... 9
5.2.1 Java包命名规则 ....................................................................................................................... 9 5.2.2 Java类命名规则 ..................................................................................................................... 10 5.2.3 Java属性命名规则 ................................................................................................................. 10 5.2.4 Java方法命名规则 ................................................................................................................. 10 5.3 词根表 ..............................................................................................................................................11 开发规范 ......................................................................................................................................................... 12 6.1 子系统/模块规范 ............................................................................................................................ 12
6.1.1 子系统命名规范 ..................................................................................................................... 12 6.1.2 模块命名规范 ......................................................................................................................... 12 6.1.3 特殊模块 ................................................................................................................................. 12 6.2 WEB层规范 ................................................................................................................................... 12
6.2.1 命名规范 ................................................................................................................................. 12 6.2.2 类编程规范 ............................................................................................................................. 13 6.2.3 方法编程规范 ......................................................................................................................... 13 6.3 业务层规范 ..................................................................................................................................... 13
6.3.1 命名规范 ................................................................................................................................. 13 6.3.2 方法命名规范 ......................................................................................................................... 13 6.3.3 类编程规范 ............................................................................................................................. 14 6.3.4 方法编程规范 ......................................................................................................................... 14 6.4 实体类(PO)规范 .............................................................................................................................. 14 实现高效Java编程的基础规则 .................................................................................................................... 15 7.1 避免使用new关键字来创建String对象 ..................................................................................... 15 7.2 避免使用不必要的嵌套 ................................................................................................................. 15 7.3 避免在同一行声明多个变量 ......................................................................................................... 15
2 3
6
7
第 2 页 共 20 页
Arch4系统开发指南-开发规范篇 中科软科技股份有限公司
8
7.4 避免使用不推荐的API .................................................................................................................. 15 7.5 避免把方法本地变量和参数定义成和类变量相同的名字 .......................................................... 16 7.6 为所有序列化的类创建serialVersionUID ..................................................................................... 16 7.7 常量的定义加上final关键字 ........................................................................................................ 16 7.8 数组的声明习惯 ............................................................................................................................. 17 7.9 一行只写一条语句 ......................................................................................................................... 17 7.10 正确释放JDBC连接 ...................................................................................................................... 17 7.11 表示长整数时用L来代替l（小写L） ........................................................................................ 18 7.12 Java注释 ......................................................................................................................................... 18 JavaScript开发规范 ........................................................................................................................................ 19 8.1 JavaScript原则 ................................................................................................................................ 19 8.2 命名规范 ......................................................................................................................................... 19 8.3 JavaScript注释 ................................................................................................................................ 20
第 3 页 共 20 页
Arch4系统开发指南-开发规范篇 中科软科技股份有限公司
1 前言
本文档是《《Arch4系统开发指南-开发规范篇》，文档讲述的内容要求所有开发人员必须遵守。 参与项目开发的任何开发人员如果对本文档讲述的内容有疑问，在开发前请询问项目经理，不允许任何开发人员以任何理由违反本文档讲述的规范要求。
1.1 文档编写目的
规范开发思想，约束开发行为，明确开发纪律。
特别约定：
1. 本章规范中，我们用“subsystems”代表“各个子系统”。例如“subsystems的Action类”表述为
“各个子系统的Action类”。
2. 本章规范中，我们用“module”代表“模块”。例如“module的POJO类”表述为“模块的POJO
类”。
3. 本章规范中所有的英文单词都是严格遵守大小写的。
1.2 文档适用范围
本文档适用于使用Arch4架构开发系统的项目组成员。下表是本文档对于项目组成员的最低要求程度：
项目组成员 项目经理 系统分析师（业务） 系统分析师（技术） 高级程序员 开发工程师 质量保证工程师 是否必读 ■是 □否 ■是 □否 ■是 □否 ■是 □否 ■是 □否 □是 ■否 要求程度 □了解文档结构 ■明白文档内容 □透彻理解 ■了解文档结构 □明白文档内容 □透彻理解 □了解文档结构 □明白文档内容 ■透彻理解 □了解文档结构 ■明白文档内容 □透彻理解 □了解文档结构 ■明白文档内容 □透彻理解 □了解文档结构 □明白文档内容 □透彻理解 对于项目经理、系统分析师、高级程序员和开发工程师，还需要阅读《Arch4系统架构设计说明书》。
1.3 修订历史
修订章节 全部 类型 重整 日期 2012-02-01 作者 周咸立 新建文档 说明 第 4 页 共 20 页