代码开发规范.docx

市民融合服务云平台代码开发规范

项目编号:
项目名称:
编写人:
编写日期:
审核人:
审核日期:
批准人:
批准日期:
修订记录
修订人
修订日期
修订内容


编写本文档主要目的是:使市民融合服务平台能以标准的、规范的方式设计和编码。通过建立编码规范,以使每个开发人员养成良好的、统一的编码风格和习惯,提高程序的可靠性、可读性、可修改性、可维护性和一致性,保证软件产品的质量。

市民融合服务平台相关人员
架构师
开发人员
工具使用规范

编号
软件工具
备注
1

2
Tomcat
3
mysql客户端
4
软件配置工具SVN安装版
5
Memcache 客户端
6
UltraEdit
可选
7
Putty
Linux远程登录工具,可选
8
WinSCP
Linux FTP上传工具,可选
9
XManager
Linux远程桌面工具,可选
10
SUN
11
nginx
12
mongodb
文档规范
项目编号、项目命名规范。
无论是项目编号,还是项目名称(项目简称、项目全称),每个项目都有一个统一的编号、简称、全称。我们的项目名称为市民融合服务云平台,项目编号为(“待续”)
文档编号、文档命名不规范。
每份文档都有一个编号,如某项目文档编号由WD_PA_PRO_YYMMDD_姓名拼写组成,其中WD表示公司名称,PA表示项目编号,PRO表示文档类型、此处指的是项目过程书,YYMMDD表示日期,姓名拼写表示姓名的拼音三个字母组成,不足三位的补“X”或“Y”。而在使用过程中,有的不知道PA是表示项目编号,有的日期格式写成YYYY-MM_DD,有的随意增加其它内容。文档命名通常由编号与文档类型名称组成,如项目过程书文档规范的命名是“WD_PA_PRO_YYMMDD_姓名拼写项目过程书”。
文档页眉、页脚规范
页眉页脚使用公司的Logo ,它是公司的标志,也说明这一份文档不仅是代表项目组,也是代表公司的形象。而页眉、页脚上的logo或标志应该是固定的,项目组不应该随意性修改。
文档的版本标识规范
根据配置管理的定义,文档控制级别为中、低的文档是不需要进行版本控制的,比如那些一些临时性的、一次性的、中间性的文档,而文档控制级别较高的文档要进行版本管理。在一些控制级别的文档中,如:用户需求说明书,概要设计说明书等,无论修改有多少次,没有留下版本记录。有的文档标识有版本记录,一个版本对应一份文档,比如《》、《》等,这样维护文档容易出错。
文档主体的裁剪、格式规范
与标准文档模板相比较,项目文档主体内容裁剪要规范,不能随意性增加或删除文档目录的内容,如:标准模板上主体内容有5章,而项目文档经过裁剪后只写3章,或者是写6章,增加一章的内容。对于文档格式,大都是
要完全遵循标准文档模板。
文档审核意见和签名批复
在项目文档中,大部分文档结尾部分都有相关人员的签名审批,文档在流转过程中有相关的干系人阅读,如果他们没有意见则同意签名,这是对文档进行走查、验证管理的一个重要证据,也是对项目文档质量进行控制的一个重要手段。
模板使用规范
在项目不同阶段,每个阶段要产生哪些类型文档,基本上固定的。如需求阶段要产生《调研报告》、《用户需求说明书》、《需求确认书》。
文档的位置存放
为便于文档管理,项目都建立了一个个文件夹,请参照配置库目录存放文档
该写的文档不写
开会没有《会议纪要》,会上发言承诺信誓旦旦,会后忙碌全抛脑后;沟通交流没有备忘录,需求变更、系统问题没有记录,过后问题弄不清楚;下达命令没有计划,安排工作排脑袋。对于项目活动不规范,直接影响文档不规范,那就是没有此文档。
业内通用开发规范
Java规范
.命名
1. 包的命名(全部小写,由域名定义)
Java包的名字都是由小写单词组成。但是由于Java面向对象编程的特性,每一名Java程序员都可以编写属于自己的Java包,为了保障每个Java包命名的唯一性,在最新的Java编程规范中,要求程序员在自己定义的包的名称之前加上唯一的前缀。由于互联网上的域名称是不会重复的,所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。 
.digitalchina
2. 类的命名(单词首字母大写)
根据约定,Java类名通常以大写字母开头,如果类名称由多个单词组成,则每个单词的首字母均应为大写例如TestPage;如果类名称中包含单词缩写,则这个所写词的每个字母均应大写,如