开发工作规范.doc

开发工作规范

目录
1 目的 1
2 范围 1
3 术语 1
常用命名规则 1
4 编码规范 1
JS编码规范 1
命名规范 1
编写规范 2
代码注释规范 2
变量使用规范 3
函数使用规范 3
其它规范 4
编码规范 5
编码原则 5
命名规范 5
其他规范 5
避免SQL注入式攻击的代码处理 6
SQL编码规范 6
通用规范 6
变量命名规范 7
视图编码规范 7
存储过程编码规范 8
触发器编码规范 9
自定义函数编码规范 10
5 功能设计规范 10
图标使用规范 10
提示信息规范 10
其它设计规范 12
文件及文件夹命名规范 12
逻辑流程规范 13
动作点规范 13
典型功能点 13
通用默认规范 14
界面整体规范 14
数据样式规范 15
边界规范 15
默认值规范 15
特殊字符集合 15
目的
本文的目的是为了规范项目开发活动中开发阶段的产出物,为团队协作提供依据,提升协作效率;并给开发阶段提供工作依据,改善产品源代码的可读性,提升产品的可维护性,降低维护成本。
范围
本文详细描述了产品开发过程中所有编码实践需要遵循的编码规范及功能设计规范,属于在开发明源ERP系统标准时必须遵守的。
术语
常用命名规则
术语/缩略语
解释
Camel命名法
Camel命名法:即骆驼式命名法,原因是采用该命名法的名称看起来就像骆驼的驼峰一样高低起伏。Camel命名法有两种形式:混合使用大小写字母和单词之间加下划线,例如getOrderCode和get_order_code都属于Camel命名法。我们选用混合使用大小写字母的形式。
基本原则:第一个单词的首字母小写,其余单词的首字母大写,其他的所有字符都小写。例如invoiceNumber。如果使用单词缩写,每个单词缩写后的第一个字母大写,比如strInvoiceNO。
Pascal命名法
Pascal命名法:每个单词的首字母大写,其他的所有字符都小写,比如InvoiceNumber、PrintInvoice。如果使用单词缩写,每个单词缩写后的第一个字母大写,比如CalcAreaCount、HTAlter。
编码规范
JS编码规范
命名规范
JavaScript命名规范一般基于Java命名规范,由26个英文字母的大小写(A..Z,a..z)、10个数字(0..9)、“_”(下划线)组成。避免使用国际化字符(如中文),因为它们不是在任何地方都可以被方便的阅读和理解。不要在命名中使用“\”(反斜杠)。
场景
命名规则
示例
类命名规范
Pascal命名规范:名称中的所有单词首字母大写。
SaleOrder()
函数命名规范
Camel命名规范:名称中的第一个单词的首字母小写,其余单词首字母大写。
getRoomCode()
局部变量命名规范
Camel命名规范:变量类型缩写+业务名称
var strRoomCode;
私有函数命名规范
使用“_”(下划线)+ Camel命名规范。(注:当使用面向对象编程进行代码封装时,才会使用到私有函数)
_initial: function() {
//...
}
私有变量命名规范
使用“_”(下划线)+ Camel命名规范。
= null;
常量命名规范
全部字母大写,且单词间添加“_”分隔。
var SYSTEM_CODE = “090102”;
变量&对象类型
前缀
示例
整数类型
int
intOrderQty
日期类型
dtm
dtmOrderDate
浮点类型
flt
fltOrderAmount
字符串
str
strOrderCode
数组
ary
aryOrderType
文本框
txt
txtProjectCode
下拉框
ddl
ddlProject
单选框
rdo
rdoProjectType
复选框
chk
chkProjectType
隐藏控件
hid
hidProjectGUID
按钮
btn
btnSave
图片
img
imgSave
IFRAME标签
ifm
ifmOr