项目开发规范.doc

项目开发规范
引言
概述
和JAVA开发管理应用系统中编码提供参考和依据,该规范结合本人在项目中的实践经验同时参考一些软件行业编码规则编写而成,以此作为项目开发标准,规范。
本编码规范不但从代码组织,外观,注释,命名,语句等方面制定规范,而且还考虑通过编码保证和提升系统的性能。
编写目的
使编写的代码在整个项目中具有规范、标准,统一的风格。
编码规范是公司软件系统质量控制的重要内容,标准、规范的代码可以保证和提高软件系统性能。
方便代码的交流,提高编码的效率,符合大众习惯。
使代码更美观、逻辑清晰,可读性强(便于阅读和理解),可移植性强,便于系统后期维护。
读者对象
公司项目决策管理层
项目负责人及项目管理人员
系统分析,设计人员
程序开发人员及测试人员
软件质量管理人员
背景
在项目开发中的编码规范是软件开发基本必须的工作,同时也是软件质量的重要保证,做为项管理和开发人员具有良好、规范的编码习惯是基本要求。但编码规范在软件开发过程中经常不被重视,经常见到的是没有编码规范,有编码规范但没有真正很好地按编码规范进行控制。针对该问题我们出此规范,作为我们开发过程标准规范。
适应范围
平台的软件采用C#开发的软件系统。
JAVA语言及平台开的软件产品。
ORACLE数据库PL/SQL语句。
程序中JavaScript代码。
定义
Pascal 命名约定
将标识符的首字母和后面连接的每个单词的首字母都大写即每个单词的首字母大写。例如:BackColor。
Camel 命名约定
标识符的首字母小写,而每个后面连接的单词的首字母都大写。例如:backColor。
参考资料
暂无。
文档标志
编写者:张洪波
参与人员:张洪波
编写时间:2010-05-13
版本:
文档总体说明
这里针对一些编码中大的原则及公共的地方在这里统一进行描述和说明:
Pascal和Camel规则在C#,JAVA,JS中应用
涉及到公共接口部分如:接口,类中方法均采用Pascal规则。
涉及到变量一般采用Camel规则
ORACLE中对象如表名,字段名,函数名,存储过程名,序列,包均全部大写。
C#编码规范
程序组织结构
Web的目录结构一般组织如下:
编号
文件
描述
备注
10
WebUI
用户界面层

1001
UserControls
用户控件

1002
mon
UI公共部分

1003
Test
测试页面

1004
Temp
临时文件夹

1005
Include
Include文件夹

100501
JsFile
JS脚本

100502
CssFile
CSS样式文件

100503
Image
用户图片

100504
Images
系统图片

1006
DVLP
辅助开发部分
对项目辅助,辅助系统开发,实施和维护,原则上删除对系统没有影响,但一般情况下会留在系统中。
1007
bin
DLL文件

1008
BaseData
基础数据

1009
PurchaseManage
采购管理

1010
……
……

20
BnsLog
业务规则层

2001
BaseData
基础数据

2002
PurchaseManage
采购管理

2003
……
……

30
数据访问层


3001
BaseData
基础数据

3002
PurchaseManage
采购管理

3003
……
……

40
DataEntity
实体层

4001
BaseData
基础数据

4002
PurchaseManage
采购管理

4003
……
……

50
DataBase
数据库层

60
CommClass
通用层

文件组织规范
文件命名
文件名遵从Pascal命名法,无特殊情况,扩展名小写。
使用统一而又通用的文件扩展名: C#
文件命名尽量使用有意义的名子命名如:,表示是对数据库操作的类。禁止使用没有意义的文件名:
文件代码行数
避免使用大文件。如果一个文件里的代码超过300~400行,应该考虑将代码分开到不同类中。
文件注释
文件注释格式如下:
// *******************************************