公司程序設(shè)計(jì)書記述標(biāo)準(zhǔn)分析

1、21/22-程序設(shè)計(jì)書記述標(biāo)準(zhǔn) 批準(zhǔn)人劉巖審核人崔戈擬制人羅世毅批準(zhǔn)日期1999.5.12生效日期1999.5.12關(guān)聯(lián)文件設(shè)計(jì)文檔治理規(guī)程（R-05004）設(shè)計(jì)文檔標(biāo)準(zhǔn)（S-04001）沈陽東東系統(tǒng)集成有限公司更改記錄序號發(fā)行日更改對象更改內(nèi)容批準(zhǔn)審查擬制01999.5.12新發(fā)行劉巖崔戈羅世毅目 錄 1. 前言2/9 2. 程序設(shè)計(jì)書的設(shè)計(jì)思路2/9 3. 程序設(shè)計(jì)書的構(gòu)成2/9 4. 文檔的寫法2/9 5. 程序設(shè)計(jì)書樣例3/9 1.前言 程序設(shè)計(jì)書是在程序設(shè)計(jì)時(shí)，定義程序的模塊和各模塊的外部規(guī)范的文檔。換言之，是規(guī)定程序具有什么樣的構(gòu)成要素、各構(gòu)成要素占有什么樣的位置、實(shí)現(xiàn)什么樣的功能

2、的文檔。2.程序設(shè)計(jì)書的設(shè)計(jì)思路( 1)以系統(tǒng)規(guī)范書和系統(tǒng)設(shè)計(jì)書為基準(zhǔn)。( 2)在充分理解了該程序要做什么的基礎(chǔ)上進(jìn)行程序設(shè)計(jì)。關(guān)于不明確的地點(diǎn)，不要隨意地推斷，而應(yīng)同系統(tǒng)設(shè)計(jì)者進(jìn)行確認(rèn)。( 3)要明確地記述程序是完成什么功能的。( 4)原則上不寫模塊內(nèi)的邏輯關(guān)系（算法/流程等）。若對講明功能有用時(shí)，作為補(bǔ)充資料附加上。( 5)要明確記述模塊的層次結(jié)構(gòu)和模塊接口。( 6)程序設(shè)計(jì)書可模塊一覽表、模塊講明書，程序流程圖及補(bǔ)充資料構(gòu)成。( 7)程序設(shè)計(jì)書對程序制作來講，是防止處理功能遺漏及重復(fù)的，并在編碼前明確接口及子功能資料。( 8)是他人可對程序進(jìn)行維護(hù)的資料。因此，程序設(shè)計(jì)書作為在看源程序清

3、單時(shí)的輔助資料，要寫得簡單、易明白。( 9)不要漏寫必要的信息,也不要寫不必要的重復(fù)信息。(10)程序設(shè)計(jì)書與源程序在一起是一個完整的文檔。 因此，在程序設(shè)計(jì)書中不要記載不必要的編碼內(nèi)容。 另外，關(guān)于理解源程序有關(guān)心的信息要作為輔助資料盡量附加上。(11)關(guān)于異常處理功能也要在充分研討之后寫上，錯誤一覽也可歸納總結(jié)為另外的文件。3.程序設(shè)計(jì)書的構(gòu)成程序設(shè)計(jì)書必須包含封面，修改履歷，目錄，可依照實(shí)際情況選擇模塊構(gòu)成圖，模塊構(gòu)成表，畫面項(xiàng)目屬性講明，全局變量講明，事件一覽表，Class關(guān)系圖，Class構(gòu)成講明，Class交互圖，畫面遷移圖等項(xiàng)目4.文檔的寫法 文檔格式若本文件沒有特不規(guī)定的話，遵

4、循公司的設(shè)計(jì)文檔治理規(guī)程（R-05004）和設(shè)計(jì)文檔標(biāo)準(zhǔn)（S-04001）。當(dāng)客戶指定標(biāo)準(zhǔn)時(shí)，遵循其指定的標(biāo)準(zhǔn)。 在功能表示上要留意以下幾點(diǎn)：(1)敘述要簡明清晰。 幸免使用含義模糊或者涉及范圍專門廣的詞。(2)不使用否定之否定形態(tài)的句子。(3)數(shù)據(jù)名稱在系統(tǒng)中要統(tǒng)一。 消息名稱、事件名稱、設(shè)備名稱、功能名稱等。5程序設(shè)計(jì)書樣例1.Class關(guān)系圖2.Class交互圖 3. 畫面項(xiàng)目屬性講明 畫面4-7 畫面項(xiàng)目講明：4. Class畫面4-7 畫面項(xiàng)目講明：CBtrapi 是操縱Btrieve文件I/O的類。畫面中的數(shù)據(jù)操作是用CbtrApi類做成Btribeve文件。類的層次和相關(guān)類 Cb

5、trApi 文件I/O類類成員 內(nèi)部變量 m_sPosBlock BTRCALL函數(shù)的位置塊 *pCFileInfo 指定Btrieve文件信息類的指針 屬性（protected） 構(gòu)造 CBtrApi *pCFileInfo的初始化 數(shù)據(jù)轉(zhuǎn)換（protected） CharToStr 記錄從Hex轉(zhuǎn)換成CSring StrTochar 記錄從CSring轉(zhuǎn)換成Hex 操作（public）GetFirst 用Btrieve文件取得第一個記錄GetNext 用Btrieve文件取得當(dāng)前記錄后面的記錄Open 打開指定的Btrieve文件Insert 用Btrieve文件插入新的記錄Updata

6、更新指定的記錄Delete 刪除指定的記錄Close 關(guān)閉Btrieve文件5. 函數(shù)一覽序號函數(shù)名稱函數(shù)描述com_ora_Connect提供與Oracle數(shù)據(jù)庫的連接com_ora_disconnect斷開與Oracle數(shù)據(jù)庫的連接com_ora_WriteBin將文件傳送給數(shù)據(jù)庫表的二進(jìn)制字段com_ora_ReadBin將數(shù)據(jù)庫表的二進(jìn)制字段傳送給文件com_ora_GetCode獵取可用舉報(bào)編號或案件編號com_ora_TD_New在業(yè)務(wù)字典中插入一個新項(xiàng)com_ora_TD_Upgrade對業(yè)務(wù)字典進(jìn)行版本升級com_ora_TD_Flg設(shè)置業(yè)務(wù)字典當(dāng)前版本的有效標(biāo)志com_ora

7、_SetRolePower取消/給予角色權(quán)限com_ora_SetOperationPower取消/給予操作權(quán)限com_ora_SetFunctionPower取消/給予職能權(quán)限com_ora_SetEndCaseFlag設(shè)置是否結(jié)案標(biāo)志com_ora_SetEndCaseDate設(shè)置結(jié)案時(shí)刻com_ora_SetReferenceFlag設(shè)置參照標(biāo)志com_ora_UpdateCaseCode修改案件編號com_ora_GetCavity獵取舉報(bào)或案件的空號6. 畫面一覽序號窗體名稱窗體描述FrmAbout關(guān)于系統(tǒng)FrmAcedObjIn被舉報(bào)對象的錄入FrmAcedObjOpt舉報(bào)立案時(shí)選

8、擇被舉報(bào)對象FrmAcedPsonDetail顯示被舉報(bào)人的詳細(xì)情報(bào)信息FrmAcedPsonView被舉報(bào)人一覽選擇FrmAnwserObjView待答復(fù)對象一覽(助手中詳細(xì)按鈕用)FrmAssistant助手FrmCaseAvisoInfo案情通報(bào)情報(bào)FrmCaseAvisoShow案情通報(bào)情報(bào)FrmCaseAvisoView案情通報(bào)情報(bào)一覽FrmCaseCodeVary案件編號變更FrmCaseDealCount統(tǒng)計(jì)中案件處理情況FrmCaseDealSum案件處理情況專項(xiàng)統(tǒng)計(jì)FrmCaseInfoView一個舉報(bào)的立案情況FrmComeUnitOpt轉(zhuǎn)來單位選擇FrmDisagreeU

9、nitOpt不同意結(jié)案單位選擇FrmDispartInfo指定分級情報(bào)FrmDispOpt處理情報(bào)選擇FrmDispType處理類不變更、處理類不選擇、轉(zhuǎn)辦處理確認(rèn)FrmEndReInfo結(jié)案答復(fù)情報(bào)FrmEndReShow結(jié)案答復(fù)情報(bào)表示FrmEndReView結(jié)案答復(fù)情報(bào)一覽FrmEnqReCaseView詢問答復(fù)案件一覽(助手中詳細(xì)按鈕用)FrmEnqReInfo詢問答復(fù)情報(bào)FrmEnqReShow詢問答復(fù)情報(bào)表示FrmEnqReView詢問答復(fù)情報(bào)一覽FrmFundStore入庫情況FrmGrant產(chǎn)品授權(quán)情報(bào)登記FrmHandResultSum上報(bào)結(jié)果情況專項(xiàng)統(tǒng)計(jì)FrmInfoSet

10、情報(bào)信息設(shè)定FrmInfoSetDatail情報(bào)設(shè)定詳細(xì)FrmInspPayTaxInfo檢查補(bǔ)稅情報(bào)一覽FrmInspPsonInfoView檢查人員情報(bào)一覽FrmInspPsonOpt檢查人員選擇FrmInspRepInfo檢查報(bào)告情報(bào)FrmInspRepShow檢查報(bào)告情報(bào)表示FrmInspRepView檢查報(bào)告情報(bào)一覽FrmLderPostil領(lǐng)導(dǎo)批示情報(bào)FrmLderPostilView領(lǐng)導(dǎo)批示情報(bào)一覽FrmLderSignSum領(lǐng)導(dǎo)批示情況專項(xiàng)統(tǒng)計(jì)FrmLock系統(tǒng)鎖定FrmLogIn系統(tǒng)登錄FrmMain本系統(tǒng)的主畫面FrmMidRepInfo中間報(bào)告情報(bào)FrmMidRepShow中間報(bào)告情報(bào)表示7.函數(shù)講明函數(shù)序號：15函數(shù)名：com_ora_UpdateCaseCode功能講明： 修改案件編號。 函數(shù)頭部： Public Function com_ora_UpdateCaseCode(ByVal P_OLDCODE As String, ByVal P_NEWCODE As String ) As Long參數(shù)及返回值：參數(shù)名類型I/O講明P_OLDCODEStringI舊的案件編號P_NEWCODEStringI新的案件編號返回值Long