系统开发代码规范.doc

系统开发代码规范
北京慧点科技开发有限公司
2005年9月
目录
一、Domino网络域及组织的命名 3
二、Domino服务器的命名 3
三、系统验证字的命名 4
四、用户和群组的命名 5
五、模块数据库的命名 5
六、数据库各设计元素的命名 5
七、编码规范 6
八、产品开发规范 10
九、提交数据库备份命名规范 14
一、Domino网络域及组织的命名
、,开发工作主要采用分布式单域结构进行;所以在Domino网络域的命名上将采用统一域名。在服务器及人员的所属组织上也采用统一的组织名称。
Domino网络域命名
Domino网络域的命名将采用公司名称的拼音首字母做为域名;如“神华集团”的汉语拼音(shen hua ji tuan)首字母SHJT作为神华集团Domino网络工作开发域。
组织的命名
整个网络域组织与Domino网络域名称一致:SHJT
※格式:
名称
域名格式
组织名格式
神华集团
SHJT
SHJT
二、Domino服务器的命名
系统中所有Domino服务器采用以下相同的层次结构进行命名:
服务器名/ SHJT (如:APNT01/SHJT)
Domino服务器的命名规则包括:
monName)命名规则
服务器名的命名规则将由以下部分组成:
服务器名称
功能代码
平台名称代码
序号(01-09,保留扩展)
例:APNT01
AP
NT
01
服务器名定长,为6个英文字母或数字。序号跟功能代码和平台代码相关,功能代码一样的服务器扩展时,顺序号增加一。如:APNT01
服务器ID文件命名规则
服务器ID的文件命名:服务器名称+扩展名
在服务器名称将取以上服务器的命名并用小写设置,在扩展名统一为:.sid
如:
※服务器功能代码
服务器类型
代码
邮件服务器
ML
应用服务器
AP
同时具有邮件和应用功能的服务器
MA
中心服务器(Hub Server)
HU
Domino Web服务器()
WS
Domino 网关服务器(Gateway Server)
GW
※平台名称代码
平台类型
代码
WinNT(2000)
NT
Linux
LI
Sun Solaris
SO
IBM AS400
AS
三、系统验证字的命名
为了便于开发和测试,在验证字的管理也更加统一。对验证字的命名进行如下约定:
根验证字(组织)的命名规则
验证所有服务器的验证字(组织单元)的命名规则
验证用户的验证字(组织单元)的命名规则
所有验证字标识符文件(Certifier ID)的命名规则
验证标识符文件名采用英文,文件扩展名为:cid。所有服务器在域组织下注册。
验证字
名字和格式
验证字ID文件名
示例
根验证字
工作根(SHJT)

SHJT
服务器验证字
Servers

Servers/SHJT
用户验证字
所属机构名称
例:集团;分公司;

例如:,
集团/SHJT
分公司/集团/SHJT
四、用户和群组的命名
对用户及群组的命名将遵守IndiOffice产品的命名规则。
五、模块数据库的命名
数据库属性
命名规范说明
示例
数据库标题
使用中文作为数据库的标题;
发文管理
数据文件名
使用该数据库标题拼音首字母小写;

六、数据库各设计元素的命名
设计元素
命名及规范说明
示例
表单
表单名称——以“frm”开头+表单中文拼音代码;不再使用别名,在表单备注中加以说明;
窗口标题——需用中文名称说明,或用数据库标题;
段落隐藏——对需要在表单中始终隐藏的部分,应放在表单最上面,需将隐藏的域放在表格中并对该域加以说明;在隐藏样式上无论是域还是文字都用“红色九号字宋体”来设置;
发布表单
frmFabu
域
域名称——以“fld”开头+域中文拼音代码;(系统特殊域出外;如:subject、body)
隐藏域名称——以“hfld”开头+域中文拼音代码;
发布日期域
fldRiqi
共享域名称——延续域的命名规则;
子表单
子表单名称——以“sfrm”开头+表单中文拼音代码;需要加备注说明;
审批意见
sfrmShenpiyj
视图
视图名称——以“vw”开头+中文拼音代码;不使用别名,需加中文备注;
发布视图
vwFabu
代理
代理名称——以“agt”开头+中文拼音代码;不使用别名,需在注释中加以