軟件(PB)開發(fā)規(guī)范.doc

程序編制規(guī)范一 命名規(guī)范1. 窗口：W_XX_XXXX(W_系統(tǒng)簡寫_功能名稱)例：藥庫入庫處理窗口為W_YK_RKCL，藥庫主窗口命名為W_YK_MAIN注：1.BSHIS2.2中主窗口繼承于W_MAIN_FRAME,MDI窗口一般繼承于 W_SHEET_FRAME2.系統(tǒng)簡寫名稱參照各產(chǎn)品的子系統(tǒng)設(shè)置規(guī)范。2. 菜單：M_XX_XXXX(W_系統(tǒng)簡寫_功能名稱)例：藥庫系統(tǒng)主菜單M_YK_MAIN注：BSHIS2.2中主菜單繼承于M_MAIN_FRAME3. 變量3.1變量的類型對象類型前綴備注整型數(shù)字IntI_界面中右對齊LongL_界面中右對齊浮點型數(shù)字DoubleD_界面中右對齊DecimalDc_界面中右對齊日期 DateD_界面中左對齊或居中格式一般為：yyyy.mm.ddDatetimeDt_Yyyy.mm.dd hh:mm:ssTimeT_HH：MM:SS類實例可視Vu_非可視U_字符串StringS_界面中左對齊或居中結(jié)構(gòu)體StructStr_布爾型BooleanB_居中3.2變量的范圍：前綴含義G全局S共享I實例L局部A參數(shù) 3.3變量命名：變量范圍+變量類型+_+變量名稱 例：全局的日期為Gd_today,門診號參數(shù)As_mzhm注：BSHIS2.2公共全局類名：Uo_support：U_supporclass BSHIS2.2全局參數(shù)結(jié)構(gòu)名：Base_info：Base_info BSHIS2.2窗口數(shù)據(jù)傳輸變量結(jié)構(gòu)：S_Exchange:S_Exchange4. 函數(shù) 公用全局函數(shù):GF_XXXX(GF+_+函數(shù)名稱)子系統(tǒng)使用的公共函數(shù):GF_XX_XXXX(GF+_+系統(tǒng)簡稱+_+函數(shù)名稱)窗口函數(shù):WF_XXXX(WF+_+函數(shù)名稱)類成員函數(shù):uf_XXXX(函數(shù)名稱)全局擴展函數(shù):GE_XXXX(GE+_+函數(shù)名稱)局部擴展函數(shù):LE_XXXX(LE+_+函數(shù)名稱)5. 數(shù)據(jù)窗口下拉式數(shù)據(jù)窗口:DD_XXXX一般數(shù)據(jù)窗口:D_XX_XXXX(D+_+系統(tǒng)簡寫+_+數(shù)據(jù)窗口名稱)6. 類U_XXXX(非可視類)VU_XXXX（可視類）7. 對象前綴標識符對象控件名稱舉例proj_工程設(shè)計對象(project object)w_窗口對象(window object)m_菜單對象(menu object)d_數(shù)據(jù)窗口對象(datawindow object)u_可視用戶對象(visiable user object)n_不可視用戶對象(invisiable user object)q_查詢對象(query object)pl_數(shù)據(jù)管道對象(data pipeline object)f_函數(shù)對象(function object)s_結(jié)構(gòu)對象(struct object)dw_數(shù)據(jù)窗口控件(datawindow control)uo_用戶對象控件(userobject control)cb_命令按鈕控件(commandbutton)cbx_復(fù)選框控件(checkbox)ddlb_下拉式列表框(dropdown listbox)ddplb_下拉式列圖片表框(dropdown picture listbox)lb_列表框(listbox)plb_圖片列表框(picture listbox)sle_單行編輯框(singlelineedit)mle_多行編輯框(multilineedit)em_編輯框(editmask)rte_重點文本編輯框(richtextedit)rb_單選按鈕(radiobutton)pb_圖片按鈕(picturebutton)vsb_垂直滾動條(vscroollvar)hsb_水平滾動條(hscrollbar)tr_事物對象(transaction)ole_OLE對象(olecontrol)p_圖片(picture)gr_圖形(graph)tab_標簽表(tab)tabpage_標簽頁表(tabpage)lv_列表視圖(listview)tv_樹視圖(treeview)st_靜態(tài)文本(statictext)ln_線(line)oval_橢圓(oval)r_矩形(rectangle)rr_圓角矩形(round rectangle)gb_組框(group box)po_PowerBuilder對象8. 庫（PBL）XX_XXXX:系統(tǒng)簡寫+_+庫名 XX_MAIN：主庫(主窗口，主菜單及本系統(tǒng)的私有維護)XX_PUBLIC:本系統(tǒng)的公用部份 XX_XXXX: 業(yè)務(wù)功能1 XX_XXXX: 業(yè)務(wù)功能2 。9. 應(yīng)用應(yīng)用名一般與系統(tǒng)的簡稱同名10. 表與視圖表:XX_XXXX(系統(tǒng)簡寫+_+表名拼音縮寫).例:住院系統(tǒng)的費用庫(ZY_FYMX)視圖:V_XX_XXXX(V+_+系統(tǒng)簡寫_+視圖名). 例:門診系統(tǒng)的收費匯總視圖(V_MZ_SFHZ)11. 字段名字段名一般是字段中文名稱拼音的首字母縮寫,一般為4個字母.如:藥品序號(YPXH) 12. 主外鍵主鍵:PK_XXXX_XXXX(PK+_+表名+_+列名)外鍵:FK_XXXX_XXXX(FK+_+表名+_+列名)13. 索引IDX_XXXX_XXXX(IDX+_+表名+_+索引名)14. 觸發(fā)器TR_XXXX_XXXX_XXXX(TR+_+所屬表名+_+作用表名+_+觸發(fā)器名). 15. 存儲過程PR_XX_XXXX(PR+_+系統(tǒng)簡寫+_+存儲過程名)二 界面規(guī)范1 用程序主窗口采用MDI方式，應(yīng)具有Miscohelp提示。覆蓋整個屏幕，應(yīng)有菜單、工具條、顯示狀態(tài)欄；菜單各項對應(yīng)打開的窗口為SHEET類型，覆蓋整個工作區(qū)，不用菜單、工具條、顯示狀態(tài)欄；應(yīng)提示信息、出錯信息、確認信息、與用戶的交互提示而彈出的窗口用RESPONSE類型的窗口，其他的彈出窗口一律用POPUP類型的窗口，并顯示在屏幕中央；所有窗口的標題顯示相應(yīng)的功能說明1、 顯示模式默認800*600顯示方式，有特殊要求的應(yīng)用程序除外。2、 功能窗體初始位置居中，縱橫尺寸比例應(yīng)采用7：4，不應(yīng)覆蓋菜單欄、工具欄和提示欄。窗體最好覆蓋整個工作區(qū)。3、 窗體中各控件安排均勻，分布合理，整個窗體應(yīng)清晰，整潔，穩(wěn)重。4、 窗體內(nèi)字體采用中文系統(tǒng)(SYSTEM)字體或宋體9號字，12號字，題頭可選楷體，不準用斜體字型。5、 窗體統(tǒng)一采用黑色字體，如有特殊要求，可選用紅色或藍色字體，但特殊色彩字體不宜過多，同一窗體色彩不能超過三種。6、 色調(diào)的運用方面，一般采用黑，白，灰。窗體底一般用灰色，字體用黑色，數(shù)據(jù)窗口底或列表及編輯框用白色。禁止使用大片其他顏色區(qū)。如有特別需要，可用其他顏色和圖標做細小的點綴。7、 應(yīng)用程序中所有按扭統(tǒng)一尺寸，統(tǒng)一顏色，統(tǒng)一采用中文系統(tǒng)字體。位置應(yīng)于窗體右側(cè)或下側(cè)，在右側(cè)的按扭的右上角為起始點，在下側(cè)的按扭以右下角為起始點。尺寸限制在400*90左右。8、 數(shù)據(jù)窗口盡量不用GRID格式，背景顏色一般用白色（TABLUES列表格式）與灰色（Freeform 錄入格式）列頭應(yīng)與每列對齊，列頭用3D格式，灰色，字體可用SYSTEM和宋體9號兩種，高度比字體稍大。9、 數(shù)值型的數(shù)據(jù)顯示或錄入必須右對齊，日期型可居中或左對齊，字符串型必須左對齊（包括以下拉數(shù)據(jù)窗口形式顯示的列）。10、菜單及按扭的快捷鍵位置放于漢字后，統(tǒng)一采用英文單詞的首字母或第一個漢字的漢語拼單首字母，如遇到雷同現(xiàn)象，可自行修改。快捷鍵包以（）。如窗體中只有兩個按扭，可不采用快捷鍵，但應(yīng)有默認ENTER和ESC鍵，如超過兩個按扭，應(yīng)采用快捷鍵，部分見附表。11、日期變量輸入和顯示統(tǒng)一采用YYYY.MM.DD的形式，例：1998.06.0112、代碼輸入采用彈出式響應(yīng)窗體，彈出式響應(yīng)窗體實現(xiàn)動態(tài)跟隨，可在窗體內(nèi)輸入輸入碼。13、窗體輸入部分支持全屏幕編輯，含ENTER鍵跳轉(zhuǎn)。14、窗體控體布局順序與TAB鍵跳轉(zhuǎn)順序一致。15、所有窗體按ESC可退出。16、輸入部分避免采用滾動條。17、代碼維護窗體和部分實現(xiàn)特殊業(yè)務(wù)的窗體采用響應(yīng)窗體。18、各對象和控件的屬性約定對象、控件或?qū)傩悦Q說明Font(字體)宋體，Regular，12，BlankFrame Window包括主菜單、Controlmenu；不含Maximizebox和Miximizebox，大小不可變， window顏色為Buttonface, client顏色為AppWrkSpc；狀態(tài)為最大化。Sheet Window繼承基類無須調(diào)整大小，一般不含菜單，通常寬度為3658，高度為2060，其他與Frame Window相同Response Window除高寬根據(jù)需要確定外，其他與Sheet Window相同DataWindow數(shù)據(jù)源一般為SQLselecet，顯示方式為對單條記錄輸入輸出為Freeform，背景顏色為Buttonface；對多行記錄輸入輸出為Tabular或Grid，背景顏色為White；Text Object：3D raised(Tabular或Grid)或None(Freeform)， Center，Buttonface，最左位置為(9,8)，高度為 72，寬度根據(jù)需要設(shè)置；Column Object：3D Lowered(Freeform)、 Box(Tabuar)或 None(Grid)，White，最左位置為(9,8)，高度為 72，寬度根據(jù)需要設(shè)置； 列的背景顏色可為Buttonface；Compute Field：與Column Object相同。TabPicture on left，Show text，Show picture，Bold selected text，Center，ButtonFaceTabPage背景顏色和文字背景顏色：ButtonFace，文字顏色：WndtextDataWindowControlVscrollBar，Live Scrolling，3D LoweredUserObjectControl3D Raised，ButtonFaceCommandButton高度為100，寬度為398或根據(jù)具體需要調(diào)整StaticTextNone，背景顏色ButtonFace，高度76；動態(tài)顯示信息則邊界為3D LoweredEditMask3D Lowered，背景顏色White，高度76DropDownPictureListBoxVscrollBar，3D Lowered，背景顏色WhiteGroupBox3D Lowered，背景顏色ButtonFaceCheckBox3D Lowered，背景顏色ButtonFace，高度76RadioButtonRight Text，3D Lowered，背景顏色ButtonFace，高度76DropDownListBox與DropDownPictureListBox相同如控件是從基類中繼承的，則屬性為標準屬性，可根據(jù)調(diào)用函數(shù)來改變屬性。19功能鍵的約定功能鍵名稱功能鍵約定說明退出系統(tǒng)ALT+F4退出主窗口及系統(tǒng)退出sheet窗口CTRL+F4退出當前的子窗口(sheet窗口)退出鍵ESC退出response和popup窗口、退出當前菜單到上層菜單幫助鍵F1打該系統(tǒng)的幫助文件確認鍵F2在數(shù)據(jù)保存時確認數(shù)據(jù)的合法性并保存數(shù)據(jù)，在查詢數(shù)據(jù)時確認輸入的條件實現(xiàn)確認按鈕的功能插入鍵F3用于在數(shù)據(jù)窗口中插入新的記錄刪除鍵F4用于在數(shù)據(jù)窗口中刪除當前的記錄查詢鍵F5輸入查詢條件、刷新數(shù)據(jù)選頁鍵F7、F8、ALT+1-9切換tabpage頁，F(xiàn)7向前、F8向后；ALT+1-9數(shù)字為指定的頁碼打印鍵F6打印更換用戶F12從新登入更換用戶翻頁鍵Home、End、PageUp、PageDown用于翻頁查看選取的記錄，Home翻到第一頁，End翻到最后一頁，PageUp翻到前一頁，PageDown翻到下一頁TAB鍵TAB、Shift+Tab用于按TabOrder向前或向后移動光標選擇鍵Return用于選擇菜單或選取數(shù)據(jù)時使用切換鍵Ctrl+Tab用于MDI方式下切換多個窗口頁20一般按鈕的屬性 按鈕名稱熱鍵說明確認ALT_O一般用于設(shè)置，確定表示修改有效保存設(shè)置并關(guān)閉窗口，一般不用熱鍵，用Enter鍵觸發(fā)。取消ALT_C一般用于設(shè)置，表示修改無效并關(guān)閉窗口，一般不用熱鍵，用ESC鍵觸發(fā)。保存ALT_S在窗口錄入信息比較多時，在記錄錄入時需不斷保存時采用。退出ALT_X關(guān)閉窗口，一般不用熱鍵，用ESC鍵觸發(fā)，查詢ALT_Q設(shè)置條件后從新檢索數(shù)據(jù)。刷新ALT_F直接從新檢索數(shù)據(jù)。統(tǒng)計ALT_S在從新檢索數(shù)據(jù)過程中有增加ALT_A記錄增加刪除ALT_D記錄刪除修改ALT_M記錄修改三.編碼風格1Script程序的組成部分。程序頭部分： 對整段程序的處理說明的注冊；變量聲明部分：對全局、局部、實例、共享變量的聲明和變量注釋說明；程序主體部分：一組能完成處理某個功能的Script語句，并對語句進行必要的注釋說明，各部分之間應(yīng)有空行分開。例：/當前行號，總行數(shù)/*變量說明*/long ll_CurRow,ll_RowCount2事件程序頭部分格式/*/事件名稱：/*例，窗口w_main的open事件*/功能說明：/*說明該段程序完成的處理功能*/作者：*時間：1999/10/25；修改：*時間：1999/12/01/*用戶自定義事件：/*/事件名稱：/*例，窗口w_main的open事件*/功能說明：/*說明該段程序完成的處理功能*/事件參數(shù)：/*傳遞該事件的參數(shù)列表及相對應(yīng)的說明*/事件返回：/*事件返回的值及相對應(yīng)的說明*/作者：*時間：1999/10/25；修改：*時間：1999/12/01/*3函數(shù)程序頭部分格式/*/