【正文】 件設(shè)計(jì)規(guī)格說明書 該說明書應(yīng)按照以下格式編寫，具體如下： 文檔類別及使用對象 描述本文檔的類別、使用對象及使用對象外的對象在什么情況下可以使用本文檔。 1．導(dǎo)言 1． 1 目的 描述本文檔的編寫目的。 1． 2 范圍 描述本文檔所涉及的內(nèi)容范圍。 1． 3 術(shù)語定義 對本文檔所涉及的一些語述進(jìn)行解釋。 1． 4 參考資料 中國最大的管 理資源中心 第 8 頁 共 38 頁 描述本文檔的參考資料 1． 5 版本更新記錄 記錄本文檔的版本更新記錄。 2．產(chǎn)品框架結(jié)構(gòu)圖 產(chǎn)品框架結(jié)構(gòu)圖描述整產(chǎn)品的體 系結(jié)構(gòu)，應(yīng)包含如下內(nèi)容：整個(gè)產(chǎn)品的體系結(jié)構(gòu)圖（模塊圖），各模塊接口關(guān)系。 3．軟件處理流程圖 該流程圖應(yīng)是基于模塊的。每個(gè)模塊的流程圖分主流程圖和細(xì)化的流程圖。細(xì)化的流程圖的劃分標(biāo)準(zhǔn)，以一個(gè)獨(dú)立的業(yè)務(wù)對象或功能對象為依據(jù)。 軟件處理流程圖的內(nèi)容：功能處理流程的描述，主要處理方法的描述，主要系統(tǒng)參數(shù)的定義，與其他系統(tǒng)接口的描述。 4．功能層次圖 是軟件完成需求規(guī)格、處理流程的具體表現(xiàn)形式。功能層次應(yīng)與業(yè)務(wù)流程相對應(yīng)，以便于在精簡或增加業(yè)務(wù)流程時(shí)，從功能層進(jìn)行相應(yīng)的減少或擴(kuò)充。主要有以內(nèi)容： 功能層次圖 功 能層次圖以樹狀結(jié)構(gòu)描述，功能層次圖中，每一項(xiàng)功能都應(yīng)規(guī)定字的功能號，這里的功能將是在軟件實(shí)現(xiàn)時(shí)進(jìn)行權(quán)限控制及作其它引用的功能號，因此在定義時(shí)必須遵循規(guī)定，這里規(guī)定功能號的格式如下： 系統(tǒng)編號（兩位） +功能層次號（ 4 位） 系統(tǒng)編號的規(guī)定參見附錄； 系統(tǒng)菜單 定義出模塊的下拉主菜單，各菜單中也要體現(xiàn)中功能號，以便于了解功能層次圖同系統(tǒng)菜單各項(xiàng)的聯(lián)系。 5．詳細(xì)設(shè)計(jì) 詳細(xì)設(shè)計(jì)應(yīng)基于功能層次圖及以前各部分資料，其主要內(nèi)容包括界面設(shè)計(jì)、程序處理流程、方法、說明等等，是程序員進(jìn)行程序設(shè)計(jì)的依據(jù)。具體內(nèi)容如下 ： —— 任務(wù)編號／名稱：作為某一任務(wù)的標(biāo)識。 —— 背景描述：對這一任務(wù)的背景進(jìn)行簡單的描述。 —— 涉及數(shù)據(jù)表（主要／相關(guān)）：該任務(wù)涉及到的主要操作表及相關(guān)操作表。 —— 界面 ： 該任務(wù)所用到的所有界面的描述。 中國最大的管 理資源中心 第 9 頁 共 38 頁 界面中所涉及到的項(xiàng)目的解釋。 —— 功能、性能：該任務(wù)要提供的功能及其描述，以及應(yīng)達(dá)到的性能要求。 —— 處理：該任務(wù)的處理流程。對于簡單任務(wù)，可不進(jìn)行描述。 —— 主要算法設(shè)計(jì)：該任務(wù)所涉及到的主要算法及描述， 對于簡單或常用的算法可不必進(jìn)行描述。 —— 注意事項(xiàng)：對于一些特別需求注意的事項(xiàng)要在此注明。 6．?dāng)?shù)據(jù)結(jié)構(gòu)設(shè)計(jì) 包括以下內(nèi)容： —— 表名／識別名稱 ： 任為表的標(biāo)識。 —— 屬性描述：描述該表的所有屬性及各屬性的屬性，主外鍵描述等，具體格式如下： 表名 表的命名，命名規(guī)范 識別名稱 表示意議的漢字名稱 索引 如有多個(gè)索引，分別列出 序號 名稱 識別名 類型 空否 缺省 檢查 主／外鍵 備注 主鍵用ＰＫ表示，外鍵用ＦＫ表示，如果為外鍵，則要在備 注中指明引用的表。該項(xiàng)內(nèi)容也可以直接從類圖生成的資料成獲得，按原格式即可。 —— 索引描述：描述該表的索引，將所有的索引都列示出來，具體格式： 索引：名稱［， unique］ [,clustered],列名 —— 涉及方法 ： 該表所涉及的操作。 第三章 軟件實(shí)現(xiàn)規(guī)范 第一節(jié) 組織方式 產(chǎn)品的結(jié)構(gòu)應(yīng)遵守的原則：執(zhí)行方便、登錄簡單、相互聯(lián)系、風(fēng)格流行。執(zhí)行方便是指在用戶在操作時(shí)能夠很方便的操作國強(qiáng)財(cái)務(wù)軟件能中的任何一個(gè)模塊；登錄簡單是指用戶在登錄國強(qiáng)財(cái)務(wù)軟件時(shí)是不需錄經(jīng)過太復(fù)雜的過程，能夠很直接的 進(jìn)行系統(tǒng)進(jìn)行操作；相互聯(lián)系是指用戶登錄進(jìn)行某一個(gè)子系統(tǒng)后，不需要再重新登錄就能直接轉(zhuǎn)換到其它子系統(tǒng)下進(jìn)行操作；風(fēng)格流行是指產(chǎn)品的形式、結(jié)構(gòu)要符合當(dāng)前流行軟件及同類產(chǎn)品中一些優(yōu)秀軟件的形式和結(jié)構(gòu)。簽于以上原則，建議國強(qiáng)財(cái)務(wù)軟件的組織方式如下： 國強(qiáng)財(cái)務(wù)軟件按照子系統(tǒng)進(jìn)行劃分，每一個(gè)子系統(tǒng)作為一個(gè)應(yīng)用軟件，建立一個(gè) 中國最大的管 理資源中心 第 10 頁 共 38 頁 獨(dú)立的圖標(biāo)，建立國強(qiáng)財(cái)務(wù)軟件組，各子系統(tǒng)的圖標(biāo)均在該組內(nèi)。 各個(gè)子系統(tǒng)的應(yīng)用菜單中，應(yīng)均有一項(xiàng)聯(lián)接其它子系統(tǒng)的菜單。 各個(gè)子系統(tǒng)的登錄方式如下：執(zhí)行程序時(shí)首先顯示一歡迎窗口，該窗口應(yīng)以簡煉、精致、準(zhǔn)確 反映信息為原則；顯示完迎窗口后顯示登錄窗口，在該窗口中應(yīng)允許輸入登錄編號、登錄口令、選擇帳套，可以新建帳套、新建用戶；登錄信息輸入正確后進(jìn)行該套帳進(jìn)行操作。具體如下圖： 各子系統(tǒng)的操作主畫面還是以傳統(tǒng)的下拉式菜單加 TOOL BAR的方式，第一行為主操作菜單，第二行為 TOOL BAR，最后一行為運(yùn)行狀態(tài)。對于各個(gè)具體操作功能，也以下拉菜單加 TOOL BAR的方式進(jìn)行操作。具體如下： 第二節(jié) 命名規(guī)范 一、數(shù)據(jù)庫對象命名規(guī)范 【目 的】 使 本產(chǎn)品的所有系統(tǒng)既相互聯(lián)系，又相互獨(dú)立。既能單獨(dú)運(yùn)行于特定的數(shù)據(jù)庫，又能同時(shí)運(yùn)行于特定的數(shù)據(jù)庫。使所有系統(tǒng)設(shè)計(jì)人員及程序員在設(shè)計(jì)數(shù)據(jù)庫對象時(shí)有據(jù)標(biāo)準(zhǔn)可依。使整個(gè)產(chǎn)品不僅在界面、風(fēng)格上一致，在內(nèi)部結(jié)構(gòu)上也采用相同的風(fēng)格，以利于整個(gè)的產(chǎn)品的共同發(fā)展。 【定義內(nèi)容】 需定義的內(nèi)容包括所有數(shù)據(jù)庫對象：表、視圖、存儲過程、觸發(fā)器及表的列。 【命名規(guī)則】 前綴 +表意名 表意名以漢字拼音簡寫或英文單詞。 【詳細(xì)內(nèi)容】 執(zhí)行圖標(biāo) 顯示歡迎信息 登錄窗口 主操用界面 菜單區(qū) TOOL BAR 區(qū) 操作區(qū) 操作員 會計(jì)日期 當(dāng)前日期 時(shí)間 軟件名稱 使用單位 中國最大的管 理資源中心 第 11 頁 共 38 頁 表 前綴 =系統(tǒng)編號 表名最長為 13 位 。 所有字符均以大寫字母表示。 如帳務(wù)系統(tǒng)中的科目字典： ZWKMZD 如銷售中的產(chǎn)品字典： XSCPZD 列 前綴 =表名 _ 表意名最長為 15 位。 所有字符均以大寫字母表示。 如科目字典中的科目編號： ZWKMZD_KMBH 視圖 前綴 = vw_ 表意串中所有字符均以小寫字母 表示，表意串即為對應(yīng)的表名。 如帳務(wù)中關(guān)于專項(xiàng)核算的視圖： vw_gszwhszd 存儲過程 前綴 =pr+變量類型 表意串中的各意義段的第一個(gè)字符為大寫字母。 如取得兩字符串中不同部分的存儲進(jìn)程： prsTwoStr 觸發(fā)器 命名規(guī)則不同于以上： 前綴 +對應(yīng)表名 +后綴 前綴 =tr_ 后綴根據(jù)觸發(fā)器的性 質(zhì)決定： 插入觸發(fā)器 _ins 刪除觸發(fā)器 _del 更新觸發(fā)器 _upt 如：科目字典增加觸發(fā)器： tr_gszwkmzd_ins 部分表義名的構(gòu)成： 代表意義 標(biāo)識符 中國最大的管 理資源中心 第 12 頁 共 38 頁 編號 Bh 名稱 Mc 金額 Je 數(shù)量 Sl 外幣 Wb 單價(jià) Dj 匯率 Hl 字典 Zd 明細(xì) Mx 級數(shù) Js 二、 PowerBuilder 對象命名規(guī)范 【目 的】 使程序員能夠進(jìn)行無私程序設(shè)計(jì)，即避免程序員與其所產(chǎn)生的代碼之間的關(guān)系過于密切。提高程序代碼的規(guī)范化程度，使程序代碼易讀易懂，并能夠達(dá)到程序員之間相互進(jìn)行程序維護(hù)。 【定 義】 變量類型：在本規(guī)范中，用于定義變量的 PowerBuilder 數(shù)據(jù)類型和 PowerBuilder 對象類型統(tǒng)稱為變量類型。 【命名規(guī)則】 所有對象的命名皆依據(jù)下列規(guī)則： 前綴 + 表意字串 。 該規(guī)則由兩部分構(gòu)成：前綴部分依據(jù)不同類型的對象進(jìn)行不同的規(guī)則定義 ；表意字串部分一般是指該對象的含義或功能描述。含義或功能描述應(yīng)做到言簡意賅，可采用純中文 (指漢字拼音的首字母 )，純西文及中西結(jié)合的方法進(jìn)行描述。 對于 PowerBuilder Controls 的名字，不要使用 PowerBuilder 提供的缺省的純阿拉伯?dāng)?shù)字，而要使用含義明確的表意字串。 變量和對象的命字由程序員自由定義，下面的命名規(guī)范主要是對 PowerBuilder 對象 的前綴部分進(jìn)行規(guī)則定義。 【書寫標(biāo)準(zhǔn)】 前綴部分皆用小寫字母書寫；名字部分的每一個(gè)語義段的首字母的皆用 大寫書寫，也可以在前綴和表意串之間或表意串各語義段之間以下劃線連接。其他字母用小寫書寫。 【主要內(nèi)容】 以下為本規(guī)范中涉及的主要的 PB 對象： Windows， DataWindows， UserObjects； PowerBuilder Controls； Objects in DataWindow； 中國最大的管 理資源中心 第 13 頁 共 38 頁 Functions； Variables； 臨時(shí)表等。 Window， DataWindow， UserObject 命名規(guī)范 （ 1） Window 前綴： w_ + 系統(tǒng)名稱 + _表意字串 例如： 帳務(wù)系統(tǒng)中的科目字典維護(hù)窗口 : w_zw_KmzdWh （ 2） DataWindow 前綴： dw_ + 系統(tǒng)名稱 + _表意字串 例如： 帳務(wù)系統(tǒng)中的科目字典數(shù)據(jù)窗口 (查詢用 )： dw_zw_KmzdWh_cx