2020年(流程管理）流程编写规范

《2020年(流程管理）流程编写规范》由会员分享，可在线阅读，更多相关《2020年(流程管理）流程编写规范（20页珍藏版）》请在金锄头文库上搜索。

1、Software Project Management Standards SUNTEK R9 连接数据库失败 / SPMS-SEP-10 C+编码规范 新太科技有限公司版权所有2003 9/21 /上传报文：|282600|9999|帐号|密码| /下传报文：|282600|返回码| /* 规则规则 3-93-9：注释应与其描述的代码相近，对子函数代码的注释应放在其上方，需与 其上面的代码用空行隔开；对函数中代码的注释应置于右方相邻位置，不可放在下 面。 规则规则 3-103-10：流程文件中尽量使代码右方注释处于同一列，方便阅读理解。 规则规则 3-113-11：流程中重要部分一定要注释。

2、例如菜单选择后状态跳转。 规则规则 3-123-12：涉及数据库操作必须注明实际 SQL。 说明：明确数据库操作目的，方便后期调试、测试核对流程。 例 6： /* 查询不得注册用户黑名单（如电话卡用户）* /function name: funcQueryRegBlacklist /function usage: 查询主叫号码是否在不得注册用户黑名单（如电话卡用户） /传入参数：主叫号码$CallerID /传出参数：无 /Returned：0 表示非黑名单用户 1 为黑名单用户 2 为数据库超时 /* funcQueryRegBlackList #declare IR m_nReturn=

3、0/返回值 :stWait SPMS-SEP-10 C+编码规范 新太科技有限公司版权所有2003 10/21 Assign g_sSQL, select * from qq_RegBlacklist where F_caller like StrCat g_sSQL, $CallerID StrCat g_sSQL, % ExecSQL g_sSQL /select * from qq_RegBlacklist / where F_caller like % Passed- stIsBlacklist Failed- stNotBlackList TimeOut- stTimeout :st

4、IsBlacklist Assign m_nReturn, 1 /1 表示是黑名单用户 ClearDTMF SetDTMF ? Assign SR0, MAINPATH Strcat SR0, MAINVOX29 PlayFile SR0 /“本用户不能进行注册” StopPlayBack- stExit DialTerminate - stExit Failed- stExit :stNotBlackList Assign m_nReturn, 0 /0 表示非黑名单用户 SPMS-SEP-10 C+编码规范 新太科技有限公司版权所有2003 11/21 - stExit :stTimeou

5、t Assign m_nReturn, 2 /2 表示数据库超时 - stExit :stExit Return m_nReturn /* End of 查询不得注册用户黑名单 * 规则规则 3-133-13：播放语音必须注释放音实际文字。 便于核对流程，以及方便阅读，以及语音文件遗失情况下恢复 例 7： :stBegin ClearDTMF SetDTMF 12 Assign SR0, INCARDPATH Strcat SR0, REGINPUTVOX1 /请输入您的个人资料，男生按 1, 女生按 2 PlayFile SR0 StopPlayBack- stSelectSex/选择性别

6、DialTerminate - stSelectSex SPMS-SEP-10 C+编码规范 新太科技有限公司版权所有2003 12/21 Failed- stSelectSex 规则规则 3-143-14：在流程中使用到全局变量必须注释用途含义，保持全局变量含义统一， 避免在另外一处改变其含义。 例 8： :stPromptUserType1 Assign g_nUserType, 1 /用户权限 为 1 级管理员 ClearDTMF SetDTMF ? Assign SR1, PROMPTUSERTYPEPATH Strcat SR1, PROMPTUSERTYPE1 /您好,您是本聊天室

7、的 1 级管理员 PlayFile SR1 StopPlayBack- stExit0 DialTerminate- stExit0 Failed- stExit0 规则规则 3-153-15：边写代码边注释，修改代码同时修改相应注释，以保证注释与代码一致 性。没用的注释要及时删除。 规则规则 3-163-16：注释内容要清楚、明了，含义准确，防止二义性。 规则规则 3-173-17：避免在注释中使用缩写，特别是非常用缩写 说明：在使用缩写时或之前，应对缩写进行必要说明。 建议建议 3-13-1：通过对函数或状态、变量等正确命名，使流程代码成为自注释的。 3.4 命名 规则规则 4-1：状态、

8、变量、函数命名只能使用英文字母、下划线以及数字的组合。应当 尽量使用常规的英文或英文缩写，避免使用无法阅读理解的命名方式。 SPMS-SEP-10 C+编码规范 新太科技有限公司版权所有2003 13/21 规则规则 4-24-2：配置文件参数，如果是字符串 string 类型的以“s”做为前缀；如果是 整数 int 类型的则以“n”做为前缀。 例 9： #iniparam int nMaxTalkRecs/系统最大的可说资源数 #iniparam string sCurrencyFaxFile/货币代码传真文件 规则规则 4-3：宏定义必须全部大写。示例参见上面例 1 中的宏定义。 规则规则

9、 4-44-4：全局变量命名参见规则 5-1“全局变量命名”。 规则规则 4-54-5：局部变量命名参见规则 5-2“局部变量命名”。 规则规则 4-6：状态命名参见规则 6-1“状态命名约定”。 规则规则 4-7：函数命名参见规则 7-2“主函数命名”、规则 7-4、规则 7-5“自定义子 函数命名”、规则 7-6“自定义例外处理函数命名”。 规则规则 4-84-8：命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以 理解的缩写。 说明：较短的单词可通过去掉元音形成缩写，较长的单词可取单词的头几个字 母形成缩写，单词的第一个字母大写。一些单词有大家公认的缩写。 例 10： 如下单

10、词的缩写能够被大家基本认可。 Send 可缩写为 Snd; Receive 可缩写为 Rcv temp 可缩写为 Tmp; flag 可缩写为 Flg; statistic 可缩写为 Stat; status 可缩写为 Sta; message 可缩写为 Msg; SPMS-SEP-10 C+编码规范 新太科技有限公司版权所有2003 14/21 规则规则 4-94-9：命名中若使用特殊约定或缩写，则要有注释说明。 规则规则 4-104-10：用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。 例 11：begin/end create/destroy insert/delete pu

11、t/get min/max 等。 3.5 变量 规则规则 5-15-1：全局变量命名要以 g_开头（g 表示 global），如果是字符串类型的则为 g_s 做前缀，如果是整型的则以 g_n 做前缀，如果是浮点型的则以 g_f 做前缀。 例 12： #declare SR g_sAstring = This is a string #declare FR g_fMyMoney = 10.5 #declare IR g_nCount 规则规则 5-25-2：局部变量命名要以 m_为前缀（m 表示 member），如果 SR 类型的则为 m_s 做前缀，如果是 IR 类型的则以 m_n 做前缀。

12、例 13： #declare SR m_sAstring = This is a string #declare FR m_fMyMoney = 10.5 #declare IR m_nCount 规则规则 5-35-3：全局变量定义区域参见规则 2-3“流程头部配置参数、宏、函数、全局变 量定义区域”，示例参见例 1。 规则规则 5-45-4：参见规则 3-4“在流程头部定义全局变量的同时须明确列出该全局变量的 含义及使用方案”。 规则规则 5-55-5：变量命名尽量符合该变量实际含义。 规则规则 5-65-6：去掉没有必要的全局变量，函数内部尽量使用局部变量。 SPMS-SEP-10 C+

13、编码规范 新太科技有限公司版权所有2003 15/21 说明：全局变量是增大模块间耦合的原因之一，故应减少没必要的全局变量以 降低耦合度。 规则规则 5-75-7：在流程开头仔细定义并明确全局变量的含义、作用、取值范围及全局变 量间的关系。 规则规则 5-85-8：当向全局变量传递数据时，要十分小心，防止赋予不合理的值或越界等 现象 说明：当向全局变量传递数据时，应进行合法性检查，并在该行对变量含义做 注释说明。 规则规则 5-95-9：寄存器变量使用一般作为 IVR 系统函数传递参数/返回值使用。流程内部 自定义函数不推荐使用寄存器变量。除了动作返回值等不得不使用寄存器变量的情 况外，一律不

14、使用一律不使用寄存器变量，用自定义变量代替。 规则规则 5-105-10：参见规则 3-14 “在流程中使用到全局变量必须注释用途含义，保持全 局变量含义统一，避免在另外一处改变其含义”。 规则规则 5-115-11：防止局部变量与全局变量同名。 规则规则 5-125-12：严禁使用未经初始化的变量作为赋值。 建议建议 5-15-1：建议不使用 IR0 或者 SR0 作为后续状态的变量，特别的，如果要超过 3 个状态后仍然需要使用当前 IR0 或 SR0 的值，先把 IR0 或 SR0 赋值给其他变量中保 存。 3.6 状态 规则规则 6-16-1：状态命名约定以“st”开头，第三个字母大写表

15、示实际有含义的名称开始。 例 14： :stWait Connect- stGetTime SPMS-SEP-10 C+编码规范 新太科技有限公司版权所有2003 16/21 :stGetTime NowTime Assign m_sTime, SR0 规则规则 6-26-2：函数中以状态 stWait 开始，以状态 stExit 结束。示例参见下面例 15、例 17。 规则规则 6-36-3：状态跳转为事件所驱动。 3.7 函数 规则规则 7-17-1：在一个业务流程程序里面只能有一个主函数。 规则规则 7-27-2：主函数只能名为 main，在开始一个业务流程的时候自动执行。 规则规则 7-37-3：在一个业务流程程序里面可以有多个子函数。 规则规则 7-47-4：子函数名不能为 main。 规则规则 7-57-5：自定义子函数除例