軟件界面設(shè)計(jì)及編碼標(biāo)準(zhǔn)規(guī)范模板

1、日期：/日期：/日期：./日期：/請?jiān)谶@里輸入公司名稱文檔編號產(chǎn)品版本密級XK-DN-2000-10-11-05V1.0內(nèi)部產(chǎn)品名稱：共頁軟件界面設(shè)計(jì)及編碼標(biāo)準(zhǔn)規(guī)范（僅供內(nèi)部使用）文檔作者：開發(fā)/測試經(jīng)理:產(chǎn)品經(jīng)理：管理辦:錯(cuò)誤！未找到引用源版權(quán)所有不得復(fù)制電能質(zhì)量數(shù)據(jù)分析軟件界面設(shè)計(jì)及編碼標(biāo)準(zhǔn)規(guī)范文檔修改記錄版本號日期所修改頁注記1.02000/10/158常見快捷鍵規(guī)定目錄一、開發(fā)環(huán)境4二、軟件界面設(shè)計(jì)標(biāo)準(zhǔn)規(guī)范42. 1編寫目的42.2內(nèi)容：42.2.1 界面設(shè)計(jì)思想42.2.2 界面設(shè)計(jì)原則42.2.3 界面設(shè)計(jì)樣式42.2.4 常見提示信息樣式42.2.5 常見錯(cuò)誤信息樣式52.2.6

2、 其他界面約定5三、軟件編碼設(shè)計(jì)標(biāo)準(zhǔn)規(guī)范53. 1.編寫目的：54. .2內(nèi)容：63. 2.1對象命名約定64. 2.2常量和變量命名約定75. 2.3結(jié)構(gòu)化編碼約定86. 2.4數(shù)據(jù)源的約定97. 2.5a據(jù)庫訪問約定98. 2.戰(zhàn)他約定9一、開發(fā)環(huán)境NT4。0、WIN98作開發(fā)操作平臺前臺采用(此處輸入開發(fā)工具名稱)作開發(fā)工具，后臺以(此處輸入數(shù)據(jù)庫名稱)作數(shù)據(jù)庫來管理數(shù)據(jù)存儲。屏幕分辨率：800*600，大字體，可在程序啟動后自動設(shè)定。軟件界面設(shè)計(jì)標(biāo)準(zhǔn)規(guī)范2.1編寫目的當(dāng)今軟件界的所有軟件無不是可視化的用戶界面，它的好處不外乎它有美觀、直接、操作者易懂和操作方便等好處。(此處輸入編寫文檔

3、的具體目的)。2.2內(nèi)容：2.2.1 界面設(shè)計(jì)思想“為用戶設(shè)計(jì)，而不是設(shè)計(jì)者”。2.2.2 界面設(shè)計(jì)原則(1)界面要美觀、操作要方便并能高效率地完成工作。(2)界面要根據(jù)用戶需求設(shè)計(jì)。(3)界面要根據(jù)不同用戶的層次設(shè)計(jì)。(有的用戶對計(jì)算機(jī)相當(dāng)了解而有的從來就沒碰過計(jì)算機(jī))(4)避免出現(xiàn)嵌套式的界面設(shè)計(jì)。(5)界面和代碼要相互制約。(6)界面要通“人性”。即要有引導(dǎo)用戶操作的功能，不能是操作一有誤就卡住什么都做不下去，又無任何提示來幫助用戶如何進(jìn)行操作。2.2.3 界面設(shè)計(jì)樣式(1)登錄界面(此處加入登陸界面圖)(1) 系統(tǒng)功能布局菜單形式(此處加入界面圖)標(biāo)簽欄形式(此處加入界面圖)(3) 錄

4、入界面(此處加入界面圖)(4) 查詢界面(此處加入界面圖)(5) 統(tǒng)計(jì)界面(此處加入界面圖)2.2.4 常見提示信息樣式（1）當(dāng)操作會帶來嚴(yán)重后果時(shí)（默認(rèn)按鈕為“否“）（此處加入界面圖）（2）當(dāng)操作會帶來一定后果時(shí)（默認(rèn)按鈕為“否“）（此處加入界面圖）（3）當(dāng)需征求操作者意愿時(shí)（默認(rèn)按鈕為“是“）（此處加入界面圖）（4）當(dāng)需提供操作者幫助時(shí)（此處加入界面圖）（5）當(dāng)操作者操作有錯(cuò)時(shí)（此處加入界面圖）（6）當(dāng)是一般提示時(shí)（此處加入界面圖）范例：（此處加入界面圖）2.2.5 常見錯(cuò)誤信息樣式（此處加入界面圖）2.2.6 其他界面約定字體：一般界面字體為宋體，字號為9Twip（只要把窗體字體設(shè)為宋體

5、，字號為9twip即可）。顏色：界面顏色采用默認(rèn)色（除非用戶有特殊要求）。按鈕：高度375Twip,除“確定”和“取消”外都需含有快捷鍵。常見按鈕快捷鍵：添加（A）、刪除（D）、查詢（S）、更新（U）、打?。≒）、關(guān)閉（C）、重新查詢（R）、統(tǒng)計(jì)（T）、退出（目。數(shù)據(jù)：REAL數(shù)據(jù)一律保留兩位小數(shù)且右對齊。對齊方式：界面上的標(biāo)題（Label）右對齊，其他控件左對齊。參考文獻(xiàn)：（此處加入?yún)⒖嘉墨I(xiàn)）三、軟件編碼設(shè)計(jì)標(biāo)準(zhǔn)規(guī)范3.1.編寫目的:使用統(tǒng)一編碼約定集的主要原因，是使應(yīng)用程序的結(jié)構(gòu)和編碼風(fēng)格標(biāo)準(zhǔn)化，以便于閱讀和理解這段編碼。好的編碼約定可使源代碼嚴(yán)謹(jǐn)、可讀性強(qiáng)且意義清楚，與其它語言約定相一致

6、，并且盡可能的直觀。一組通用目的的編碼約定應(yīng)該定義完成上述目的所必需的、能讓程序員自由地創(chuàng)建程序邏輯和功能流程的最小的要求。編碼約定的目的是使程序易于閱讀和理解，而不是用過份的約束和絕對的限制來束縛程序員本身的創(chuàng)造性。3. 2內(nèi)容：程序設(shè)計(jì)語言的特性和風(fēng)格會直接影響到軟件的質(zhì)量和可維護(hù)性。編碼原則：應(yīng)盡量避免在系統(tǒng)初始化時(shí)運(yùn)行過多的代碼。(此處加入詳細(xì)原則)(1)選用控制結(jié)構(gòu)只準(zhǔn)許一個(gè)入口和一個(gè)出口。(2)程序語句組成容易識別的塊，每塊只有一個(gè)入口和一個(gè)出口。(3)復(fù)雜的結(jié)構(gòu)應(yīng)該用基本控制結(jié)構(gòu)進(jìn)行組合嵌套來實(shí)現(xiàn)。(4)語句中沒有的控制結(jié)構(gòu)，可用一段等價(jià)的程序段模擬，但要求該程序段在整個(gè)系統(tǒng)應(yīng)前

7、后一致。(5)嚴(yán)格控制GOTO語句，僅在下列情形才可使用。用一個(gè)非結(jié)構(gòu)化的程序設(shè)計(jì)語言去實(shí)現(xiàn)一個(gè)結(jié)構(gòu)化的構(gòu)造。在某種可以改善而不是損害程序可讀性的情況下。3.2.1對象命名約定公式:，象名稱=對象前綴+自定義名稱(自定義名稱要有一定的意義且第一個(gè)字母大寫)|說明：如果是不需要對其編碼的對象，那么對象名用默認(rèn)對象名。應(yīng)該用一致的前綴來命名對象，使人們?nèi)菀鬃R別對象的類型。下面列出了Delphi支持的一些推薦使用的對象約定。(1)推薦使用的項(xiàng)目前綴控件類型前綴例子ClassModulecmdlcmdlCheckDataEnvironmentdevdevPrintsDataReportdrtdrtEn

8、glishFormfrmfrmEntryMDIFormmfrmmfrmSinoexportModulemdlmdlConnectionProjectPjtpjtCkmis(2)推薦使用的控件前綴控件類型前綴例子3DPanelpnlpnlGroupADODataadoadoBiblioAnimatedbuttonanianiMailBoxCheckboxchkchkReadOnlyComboboxdrop-downlistboxcbocboEnglishCommandbuttoncmdcmdExitCommondialogdlgdlgFileOpenCommunicationscomcomFax

9、Control(當(dāng)特定類型未知時(shí)，在過程中所使用的)ctrctrCurrentDatadatdatBiblioData-boundcomboboxdbcbodbcboLanguageData-boundgriddbgrddbgrdQueryResultxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx（3）推薦使用的數(shù)據(jù)訪問對象的前綴用下列前綴來指示數(shù)據(jù)訪問對象。數(shù)據(jù)庫對象前綴例子ConnectionconconReportsxxxdbdbAccounts一些例子：（此處加入例子）（4）推薦使用的菜單前綴應(yīng)用程序頻繁使用許多菜單控件，對于這些控件具備一組唯一的命

10、名約定很實(shí)用。除了最前面"mnu"標(biāo)記以外，菜單控件的前綴應(yīng)該被擴(kuò)展：對每一級嵌套增加一個(gè)附加前綴，將最終的菜單的標(biāo)題放在名稱字符串的最后。下表列出了一些例子。菜單標(biāo)題序列菜單處理器名稱（此處加入標(biāo)題序列及處理器名稱）當(dāng)使用這種命名約定時(shí)，一個(gè)特定的菜單組的所有成員一個(gè)接一個(gè)地列在VisualBasic的“屬性”窗口中。而且，菜單控件的名字清楚地表示出它們所屬的菜單項(xiàng)。（5）為其它控件選擇前綴對于上面沒有列出的控件，應(yīng)該用唯一的由兩個(gè)或三個(gè)字符組成的前綴使它們標(biāo)準(zhǔn)化，以保持一致性。只有當(dāng)需要澄清時(shí)，才使用多于三個(gè)字符的前綴。例如，（此處加入例子）3.2.2常量和變量命名約定

11、公式：除量或變量名稱=常量或變量范圍前綴+常量或變量類型前綴+自定義名稱（自定義名稱要力一定的意義且第一個(gè)字母大寫）|除了對象之外，常量和變量也需要良好格式的命名約定。本節(jié)列出了（此處加入變量列表）。變量應(yīng)該總是被定義在盡可能小的范圍內(nèi)。全局（Public）變量可以導(dǎo)致極其復(fù)雜的狀態(tài)機(jī)構(gòu)，并且使一個(gè)應(yīng)用程序的邏輯非常難于理解。全局變量也使代碼的重用和維護(hù)更加困難。Delphi中的變量可以有下列范圍：范圍聲明位置可見位置過程級（此處加入名稱）模塊級（此處加入名稱）全局（此處加入名稱）。較好的編碼習(xí)慣是盡可能寫模塊化的代碼。例如，如果應(yīng)用程序顯示一個(gè)對話框，就把要完成這一對話任務(wù)所需要的所有控件和

12、代碼放在單一的窗體中。這有助于將應(yīng)用程序的代碼組織在有用的組件中，并減小它運(yùn)行時(shí)的開銷。除了全局變量（應(yīng)該是不被傳遞的），過程和函數(shù)應(yīng)該僅對傳遞給它們的對象操作。在過程中使用的全局變量應(yīng)該在過程起始處的聲明部分中標(biāo)識出來。變量范圍前綴隨著工程大小的增長，劃分變量范圍的工作也迅速增加。在類型前綴的前面放置單字母范圍前綴標(biāo)明了這種增長，但變量名的長度并沒有增加很多。范圍前綴例子全局gGstrUserName模塊級mMblnCalcInProgress本地到過程無DblVelocity（此處加入說明）變量聲明所有的變量將會（此處加入說明）。應(yīng)該給變量加前綴來指明它們的數(shù)據(jù)類型。而且前綴可以被擴(kuò)展，用

13、來指明變量范圍，特別是對大型程序。變量數(shù)據(jù)類型用下列前綴來指明一個(gè)變量的數(shù)據(jù)類型。（此處加入說明）描述變量和過程名變量或過程名的主體應(yīng)該使用大小寫混合形式，并且應(yīng)該足夠長以描述它的作用。而且，函數(shù)名（此處加入函數(shù)名稱）。對于頻繁使用的或長的項(xiàng)，推薦使用標(biāo)準(zhǔn)縮略語以使名稱的長度合理化。一般來說，（此處加入特例說明）就困難了。當(dāng)使用縮略語時(shí)，要確保它們在整個(gè)應(yīng)用程序中的一致性。在一個(gè)工程中，如果一會兒使用（此處加入說明問題），將導(dǎo)致不必要的混淆。用戶定義的類型在一項(xiàng)有許多用戶定義類型的大工程中，常常有必要給每種類型一個(gè)它自己的三個(gè)字符的前綴。如果這些前綴是（此處加入前綴名稱）。3. 2.3結(jié)構(gòu)化編碼約定（此處加入約定說明）記住下列幾點(diǎn)：每一個(gè)重要變量的聲明應(yīng)該包括（此處加入變量名稱）。（2）格式化代碼因?yàn)樵S多程序員（此處加入問題）（此處加入解決問題的說明）（3）給常量分組變量和定義的常量應(yīng)該按功能分組，而不是分散到單獨(dú)區(qū)域或特定文件中。（4）運(yùn)算符（此處加入運(yùn)算符列表及說明）（5）為（此處加入問題）查詢創(chuàng)建字符串（此處加入說明）3. 2.4數(shù)據(jù)源的