互联网在线教育系统+所有开发+行业调究+市场+产品文档.docx
《互联网在线教育系统+所有开发+行业调究+市场+产品文档.docx》由会员分享，可在线阅读，更多相关《互联网在线教育系统+所有开发+行业调究+市场+产品文档.docx（15页珍藏版）》请在冰点文库上搜索。
互联网在线教育系统+所有开发+行业调究+市场+产品文档
命名规范
目的：
为了使软件开发过程有章可循，保证软件质量，加强开发管理。
同时，减小了项目开发中的风险。
1.数据库部分
注意：
命名都不得超过30个字符的系统限制。
变量名的长度限制为29（不包括标识字符@）。
1.1.表名
1.1.1.基础表
ba开头，后面用英文单词，首字母小写，需要多个英文词的每个单词首字母小写，并用下划线进行连接。
常用单词已经进行了缩写，在命名过程当中，根据辅音缩写。
举例：
定义的缩写Sales:
sal销售；
Order:
ord订单；
Detail:
dtl明细；
则销售订单名细表命名为：
ba_sal_ord_dtl。
如果表或者是字段的名称仅有一个单词，那么不使用缩写，而是用完整的单词。
举例：
定义的缩写Materialma物品；
物品表名为：
ba_material,而不是ba_ma.
但是字段物品编码则是：
ba_ma_vcID;而不是Material_vcID。
1.1.2.专用表（一般只有几个子系统时才用到）
xx开头,xx为主要用得的子系统缩写，后面的同基础表如：
pa_balance。
1.1.3.临时表（在存储过程和触发器中）
#开头后面是来源的表名如：
#bag_group或者##开头后面是调用的客户端机器名+时间，由存储过程产生，免得冲突。
1.2.字段名
表名+类型（两位，小写）+字段意义（根据辅音缩写）。
此处，字段意义首字母要大写。
如：
ba_ma_vcId。
需要多个英文词的每个单词首字母小写，并用下划线进行连接。
1.3.视图
vw开头，后面基本同基础表，如：
vw_dept_for_procss。
1.4.存储过程
prc_开头，后面基本同基础表。
1.5.函数
fn_开头，后面基本同基础表。
1.6.触发器
1.6.1.tr_表名for（after）insert,update,delete（比较多这个类型的触发器）
1.6.2.tr_表名_Insertfor（after）insert
1.6.3.tr_表名_Updatefor（after）update
1.6.4.tr_表名_Deletefor（after）delete
1.7.自定义数据类型
ud开头，Type结尾，中间是类型的描述，大小写同基础表。
1.8.Default名
df_表名_字段名。
1.9.Rule名
ru_字段名。
1.10.PRIMARYKEY名
pk_表名。
1.11.UNIQUE名
uq_表名_字段名1_字段名2...
1.12.外键（REFERENCES约束）名
fk_从表名_主表名_字段名1_字段名2...
1.13.关于注释
注释可以包含在批处理中。
在触发器、存储过程中包含描述性注释将大大增加文本的可读性和可维护性。
本规范建议：
注释以英文为主。
实际应用中，发现以中文注释的SQL语句版本在英文环境中不可用。
为避免后续版本执行过程中发生某些异常错误，建议使用英文注释。
注释尽可能详细、全面。
创建每一数据对象前，应具体描述该对象的功能和用途。
传入参数的含义应该有所说明。
如果取值范围确定，也应该一并说明。
取值有特定含义的变量（如boolean类型变量），应给出每个值的含义。
注释语法包含两种情况：
单行注释、多行注释
单行注释：
注释前有两个连字符（--），最后以行尾序列（CR-LF）结束。
一般，对变量、条件子句可以采用该类注释。
多行注释：
符号/*和*/之间的内容为注释内容。
对某项完整的操作建议使用该类注释。
注释简洁，同时应描述清晰。
函数注释：
编写函数文本--如触发器、存储过程以及其他数据对象--时，必须为每个函数增加适当注释。
该注释以多行注释为主，主要结构如下：
/****************************************************************
*name:
--函数名
*function:
--函数功能
*input:
--输入参数
*output:
--输出参数
*author:
--作者
*CreateDate:
--创建时间
*UpdateDate:
--函数更改信息（包括作者、时间、更改内*容等）
****************************************************************/
2.jsp/html部分
jsp与html文件名全部小写，并遵循如下的规范：
2.1.数据/内容显示页
名词，多个单词用下划线分隔，要求能说明显示内容的信息，为避免冲突，可加上“_list”。
举例：
new_message.html或my_file_list.jsp。
2.2.操作处理页
命名格式：
名词_下划线_动词，例如：
file_delete.jsp。
2.3.含frame页面