系统软件编制规范(pb)

'目录一引言11编写目的12背景错误！未定义书签。二设计规范11系统规划12文件管理22.1目录管理22.2文件命名规范32.3文件备份机制33程序设计规范33.1界面风格43.2命名规范63．3快捷键的定义103．4编程规范103．5编程风格11系统软件编制规范一引言1编写目的统一整个软件的界面风格,确定软件编制过程中“库文件”、“控件”、“变量”、“对象”、等的命名规范，增强软件开发过程中的规范性、使用时的易维护性。二设计规范1系统规划1.1计划制定 1.2计划实施第12页共12页 1文件管理1.1目录管理(1)目录开发过程中程序、文件、文档、备份等按功能要求分别存放在D:codeapp目录下的不同子目录下，具体如下：程序：D:codeapp模块名流程图和文档：D:codeappdoc模块名可执行文件：D:codeappexe模块名备份文件：D:codeappbak模块名sql文件：D:codeappsql模块名图片文件:D:codeappbmp模块名(2)库文件(PBL)程序开发过程中的各种对象按功能分别存放不同的PBL中，并附加说明。(如：有系统管理、计划管理、生产管理、物流分析及控制、采购管理、仓库管理、财务管理、通用查询、数据通信等模块，各模块主文件命名规则是模块名的汉语拼音缩写，分别对应如下：公共应用名称：tyfz父类组件：inherit.pbl(与业务无关)公共组件pub.pbl（与业务有关）应用一：xtgl系统管理数据窗口：xtgl_dw.pbl系统管理窗口：xtgl_w.pbl系统管理函数及其它：xtgl_func.pbl应用二：jhgl计划管理数据窗口：jhgl_dw.pbl计划管理窗口：jhgl_w.pbl计划管理函数及其它：jhgl_func.pbl应用三：scgl生产管理数据窗口：scgl_dw.pbl生产管理窗口：scgl_w.pbl生产管理函数及其它：scgl_func.pbl应用四：wlkz第12页共12页 物流分析及控制数据窗口：wlkz_dw.pbl物流分析及控制窗口：wlkz_w.pbl物流分析及控制函数及其它：wlkz_func.pbl应用五：cggl采购管理数据窗口：cggl_dw.pbl采购管理窗口：cggl_w.pbl采购管理函数及其它：cggl_func.pbl应用六：ckgl仓库管理数据窗口：ckgl_dw.pbl仓库管理窗口：ckgl_w.pbl仓库管理函数及其它：ckgl_func.pbl应用七：cwgl财务管理数据窗口：cwgl_dw.pbl财务管理窗口：cwgl_w.pbl财务管理函数及其它：cwgl_func.pbl应用八：tycx通用查询数据窗口：tycx_dw.pbl通用查询窗口：tycx_w.pbl通用查询函数及其它：tycx_func.pbl应用九：sjtx数据通信数据窗口：sjtx_dw.pbl数据通信窗口：sjtx_w.pbl数据通信函数及其它：sjtx_func.pbl各种对象应分类分别存放在相应的pbl中。建立dw.pbl存放数据窗口，建立dd.pbl存放存放下拉式数据窗口，建立func.pbl存放存放函数，据子系统的复杂程度还可进一步细分。1.1文件命名规范文件的命名要具有自解释功能，要体现模块、功能等信息。1.2文件备份机制为了开发的顺利进行，要定期的进行数据备份。这样可以避免或减少由于外界因素和系统故障等多方面的原因带来的损失，减少返工量，保证系统正常、安全的运行。2程序设计规范第12页共12页 1.1界面风格(1)窗口主窗口类型：MDI类型,框架结构模块功能窗口类型：popup类型具体可根据实际情况把握，以有利于用户操作为原则。主色调：灰底，尽量避免采用刺眼的色调。按钮：3Draisedtext:宋体，9号，黑色，居中background:灰(2)数据窗口bandHeight:75,width视具体情况而定¨维护窗口(styletype:grid、freeform)说明：当维护项目较少时，直接在主窗口数据窗口提供维护（新增、维护等）功能，此时数据窗口采用grid型；反之当维护项目较多时，维护功能要在另一窗口中完成，主窗口数据窗口则以查询窗口（不打印）形式出现，参考下项说明，此时抽、提供维护功能的数据窗口采用freeform形式。1．headboard:border:3Draisedtext:宋体，9号，深蓝，居中background:灰2．detailborder:3Dloweredtext:宋体，9号，黑色，左靠齐digital:arial，9号，黑色，右靠齐background:白、浅绿、灰（浅绿为必录入项，前台需提供校验，灰色为不可录入或修改项，光标不能进入）board:3Dloweredtext:宋体，9号，黑色，左靠齐（数字右靠齐）datawindowbackground:灰summaryboard:3Dloweredtext:宋体，9号，黑色，右靠齐digital:宋体，9号，黑色，右靠齐background:灰¨查询窗口(不打印)：(styletype:grid)1．headboard:第12页共12页 border:nonetext:宋体，9号，深蓝，居中background:灰2．detailborder:nonetext:宋体，9号，黑色，左靠齐digital:arial，9号，黑色（深蓝），右靠齐background:白1．summaryborder:nonetext:宋体，9号，黑色（深蓝），居中digital:arial，9号，黑色（深蓝），右靠齐background:灰2．Tabular，grid格式窗口左侧增加序号栏（arial，9号，深蓝，居中）。¨查询窗口：(提供打印，一般采用freeform,按用户要求格式输出)1．headborder:nonetext:宋体，10号，黑色（深蓝），居中background:灰2．detailborder:nonetext:宋体，10号，黑色（深蓝），居中digital:arial，10号，黑色（深蓝），右靠齐background:灰3．summaryboard:3Dloweredtext:宋体，10号，黑色（深蓝），居中digital:arial，10号，黑色（深蓝），右靠齐background:灰说明：本项在实际中需灵活把握。¨下拉式数据窗口：不设headboard，采用freeform形式detailborder:nonetext:宋体，10号，黑色，居左background:白summary无¨下拉列表：board:3Dloweredtext:宋体，9号，黑色（深蓝），左靠齐background:白(3)编辑框编辑框模式：3DLowered（单行编辑器等）色调：白底黑（深蓝）字第12页共12页 (4)按纽在窗口中的位置以让人马上能发觉为原则，在数据敞口横向较小时放在窗口的右边，竖向排列。在数据窗口的横向较大时按纽应放在窗口的下面，横向排列。在全屏报表中应放在数据窗口上边横向排列。text：宋体，9号，黑色（可适当调整）background：灰色大小：300*80，在同一窗口中大小要保持一致。对于按纽中汉字多少较悬殊的情况，以美观为前提可适当调整。说明：请尽可能采用公共库中提供的按钮对象及其提供的相应功能函数。(5)静态文本框background：灰色，可适当使用其它颜色来美化窗口text：宋体，黑色（深蓝），9号字，可根据需要适当调整。border:none(6)下拉列表：board：3Dloweredtext：宋体，9号，黑色background：白色在下拉列表框中不设head列(7)其它控件参考上述控件，根据需要来设置。说明：在录入界面中，要求用户必须录入或选择的项，其底色为Mint其它仍参考上述原则确定。1.1命名规范总体命名原则：对象或控件的命名要具有自解释功能，要体现模块、功能等信息。一般是模块的汉语拼音缩写加功能的汉语拼音缩写，常用的可用英语单词及缩写来表达。第12页共12页 (1)数据库(表)命名:a)数据库（表）第一部分为模块名。第二部分为汉语拼音缩写,对有特殊含义的英文单词应替代汉语拼音。(如:SAVE等)如:“系统管理”内的“操作员表”取名如下：xt_czyb)属几模块共用的数据库（表）第一部分为“pub_”第二部分为数据库（表）名，（汉语拼音缩写）如c)视图第一部分为字母“v_”第二部分为视图名，（汉语拼音缩写）如视图“客户资料”为v_khzld)存储过程第一部分为字母“sp_”第二部分为存储过程名，（汉语拼音缩写）e)触发器第一部分为字母“trig_”第二部分为触发器名，（汉语拼音缩写）(2)pb命名规范对象的命名应具有自解释功能。a).对象级(powerobject)对象的命名体现了模块，对象类型，功能等信息第12页共12页 如：显示错误信息的结构g_st_errormsg窗口命名（WINDOW）第一部分为“w_”第二部分为模块名（汉语拼音缩写或英文单词）第三部分为功能名（汉语拼音缩写或英文单词）如：变更登记窗口w_dj_bg数据窗口命名：（DATAWINDOW）第一部分为“dw_”第二部分为数据窗口（汉语拼音缩写或英文单词）第三部分为功能名（汉语拼音缩写或英文单词）如：变更登记数据窗口dw_dj_bg公共数据窗口命名：第一部分为“dd_”第二部分为“pub_”第三部分为数据窗口名（汉语拼音缩写或英文单词）如：变更登记数据窗口dd_pub_dj_bg用户对象命名：（USEOBJECT）第一部分为“uo_”第二部分为用户对象（汉语拼音缩写或英文单词）函数命名：（FUNCTION）第一部分为“f_”第二部分为函数名（汉语拼音缩写或英文单词）附：常用对象的名称前缀窗口(windows)w_数据窗口(datawindows)dw_下拉式数据窗口(dropdowndw)dd_菜单(menu)m_函数(function)f_窗口级函数(windowsfunction)wf_对象级函数(objectfunction)of_菜单函数(menufunction)mf_全局外部函数()gf_局部外部函数()lf_结构(structure)gstr_全局istr_实例lstr_局部第12页共12页 b)控制级对象中(被脚本调用的)控件的命名规范控件类型的缩写加功能的英文名或其缩写作为后缀。如：“存盘”按钮：cb_save显示信息的静态文本st_info附：常用功能的名称后缀存盘_save或update返回_return增加_insert删除_delete修改_modify检索_browse上一页_pgup下一页_pgdn打印_print设置_setupC)变量级变量的命名体现了变量辖域，数据类型等信息如：整型的全局变量次数gi_count局部字符串变量纳税人名称ls_nsrmc附：1.变量类型前缀全局变量(globevariable)g_共享变量(sharedvariable)s_实例变量(instancevariable)i_局部变量(localvariable)l_2.数据类型前缀整型(int)i_长型(long)l_字符串(string)s_双精度(double)db_日期(date)d_十进制(decimal)dec_日期时间(datetime)dt_图形对象(graphobject)go_实型(real)r_第12页共12页 时间(time)3．3快捷键的定义快捷系统一：F1帮助F2浏览F3存盘F4增加F5删除F6打印F7~F12暂时保留ESC退出上翻（上一步）¯下翻（下一步）快捷系统二：帮助cb_help增加cb_addALT+A删除cb_delALT+D存盘cb_saveALT+S确认cb_okALT+O打印cb_printALT+P浏览（检索）cb_retrieveALT+R查找cb_findALT+F统计cb_statALT+T返回cb_returnALT+B取消cb_cancleALT+C退出cb_exitALT+F4打印设置cb_setupALT+E3．4编程规范(1)前台PowerBuild前台编程设计中，应尽可能采用类库中的父类窗口、通用控件、公用函数、用户对象等，避免风格、效率、实现方式上的差异和重复劳动。同时不断丰富类库。类库中的各级对象必须严格管理和控制，不得随意修改。第12页共12页 (2)后台对于数据库操作设计，应注意以下问题：a)数据表应考虑备用字段，以便扩展；b)系统中关联各数据表的关键字段如工号、客户编号、成品款号等应考虑建立外键；c)对于同一数据表的操作，应尽可能根据索引设计where条件的字段及字段顺序，并保持系统中同类操作的一致性；d)对数据表进行插入操作时，inserttable后必须带字段名；e)存储过程中应尽量避免采用游标。对复杂过程可采用临时表；f)对于关键业务的多表操作，应考虑采用事务（transaction）及回滚机制，保证数据的一致性；g)在编写后台数据库的触发器(trigger),存储过程(procedure)时,要注意变量声明的可阅读性,段落的层次性,必要的注释等方面3．5编程风格(1)段落一般采用段落如下：变量声明、变量赋值、过程处理、提示结果，段落之间用空行隔开,段落前加注释，且与段首对齐。(2)缩进嵌套关系要有层次感，嵌套内层要缩进一个TAB的距离。(3)注释a)程序头：根据需要，程序头上加上对事件及功能的描述//========================================//事件：(事件名称)////描述：(注释文字。。。)//========================================对于函数则说明如下：//========================================第12页共12页 //功能：//参数：//返回值：//========================================b)段落注释：//(注释文字...)程序段...c)段落中关键点要有简短说明程序//(注释文字。。。)(4)提示语.提示语要有礼貌，简洁明了的表达信息，并注意使用行话，注意尽量不要使用计算机术语，对于MessgeBox要注意Question!,Stopsign!,Information!Exclamation!等符号的使用。第12页共12页'