1、文檔4日期：/日期：/日期：./日期： /請在這里輸入公司名稱文檔編號產品版本密級XK-DN-2000-10-11-05V 1.0內部產品名稱：共頁軟件界面設計及編碼標準規范（僅供內部使用）文檔作者： 開發/測試經理: 產品經理： 管 理 辦:錯誤！未找到引用源版權所有不得復制電能質量數據分析軟件界面設計及編碼標準規范文檔修改記錄版本號日期所修改頁注記1. 02000/10/1 58常見快捷鍵規定第8頁共9頁目錄一、開發環境4二、軟件界面設計標準規范 42. 1編寫目的 42. 2內容： 42.1.1 界面設計思想42.1.2 界面設計原則42.1.3 界面設計樣式 42.1.4 常見提示信息

2、樣式42.1.5 常見錯誤信息樣式52.1.6 其他界面約定5三、軟件編碼設計標準規范 53. 1.編寫目的：54. . 2內容： 63. 2. 1對象命名約定64. 2. 2常量和變量命名約定 75. 2. 3結構化編碼約定 86. 2. 4數據源的約定97. 2. 5a據庫訪問約定98. 2.戰他名定9一、開發環境NT4。0、WIN98作開發操作平臺前臺采用(此處輸入開發工具名稱)作開發工具，后臺以(此處輸入數據庫名稱)作數據庫來管理數據存儲。屏幕分辨率：800*600，大字體，可在程序啟動后自動設定。軟件界面設計標準規范2.1 編寫目的當今軟件界的所有軟件無不是可視化的用戶界面，它的好處

3、不外乎它有美觀、直接、操作者易懂和操作方便等好處。(此處輸入編寫文檔的具體目的)。2. 2內容：2.2.1 界面設計思想“為用戶設計，而不是設計者”。2.2.2 界面設計原則(1)界面要美觀、操作要方便并能高效率地完成工作。(2)界面要根據用戶需求設計。(3)界面要根據不同用戶的層次設計。(有的用戶對計算機相當了解而有的從來就沒碰過計算機)(4)避免出現嵌套式的界面設計。(5)界面和代碼要相互制約。(6)界面要通“人性”。即要有引導用戶操作的功能，不能是操作一有誤就卡住什么都做不下去，又無任何提示來幫助用戶如何進行操作。2.2.3 界面設計樣式(1)登錄界面(此處加入登陸界面圖)(1) 系統功

4、能布局菜單形式(此處加入界面圖)標簽欄形式(此處加入界面圖)(3) 錄入界面(此處加入界面圖)(4) 查詢界面(此處加入界面圖)(5) 統計界面(此處加入界面圖)2.2.4 常見提示信息樣式（1）當操作會帶來嚴重后果時（默認按鈕為“否“）（此處加入界面圖）（2）當操作會帶來一定后果時（默認按鈕為“否“）（此處加入界面圖）（3）當需征求操作者意愿時（默認按鈕為“是“）（此處加入界面圖）（4）當需提供操作者幫助時（此處加入界面圖）（5）當操作者操作有錯時（此處加入界面圖）（6）當是一般提示時（此處加入界面圖）范例：（此處加入界面圖）2.2.5 常見錯誤信息樣式（此處加入界面圖）2.2.6 其他界面

5、約定字體：一般界面字體為宋體，字號為 9Twip （只要把窗體字體設為宋體，字號為 9twip 即可）。顏色：界面顏色采用默認色（除非用戶有特殊要求）。按鈕：高度375Twip,除“確定”和“取消”外都需含有快捷鍵。常見按鈕快捷鍵：添加（A）、刪除（D）、查詢（S）、更新（U）、打印（P）、關閉（C）、重新查詢（R）、統計（T）、退出（E）。數據：REAL數據一律保留兩位小數且右對齊。對齊方式：界面上的標題（Label ）右對齊，其他控件左對齊。 參考文獻：（此處加入參考文獻）三、軟件編碼設計標準規范3. 1.編寫目的:使用統一編碼約定集的主要原因，是使應用程序的結構和編碼風格標準化，以便于閱

6、讀 和理解這段編碼。好的編碼約定可使源代碼嚴謹、可讀性強且意義清楚，與其它語言約定相一致，并且盡可能的直觀。一組通用目的的編碼約定應該定義完成上述目的所必需的、能讓程序員自由地創建程序邏輯和功能流程的最小的要求。編碼約定的目的是使程序易于閱讀和理解，而不是用過份的約束和絕對的限制來束縛程序員本身的創造性。3. 2內容：程序設計語言的特性和風格會直接影響到軟件的質量和可維護性。編碼原則：應盡量避免在系統初始化時運行過多的代碼。(此處加入詳細原則)(1)選用控制結構只準許一個入口和一個出口。(2)程序語句組成容易識別的塊，每塊只有一個入口和一個出口。(3)復雜的結構應該用基本控制結構進行組合嵌套來

7、實現。(4)語句中沒有的控制結構，可用一段等價的程序段模擬，但要求該程序段在整個系 統應前后一致。(5)嚴格控制GOTO語句，僅在下列情形才可使用。用一個非結構化的程序設計語言去實現一個結構化的構造。在某種可以改善而不是損害程序可讀性的情況下。3. 2. 1對象命名約定公式:，象名稱=對象前綴+自定義名稱(自定義名稱要有一定的意義且第一個字母大寫)|說明：如果是不需要對其編碼的對象，那么對象名用默認對象名。應該用一致的前綴來命名對象，使人們容易識別對象的類型。下面列出了Delphi支持的一些推薦使用的對象約定。(1)推薦使用的項目前綴控件類型前綴例子Class ModulecmdlcmdlCh

8、eckData EnvironmentdevdevPrintsData ReportdrtdrtEnglishFormfrmfrmEntryMDIFormmfrmmfrmSinoexportModulemdlmdlConnectionProjectPjtpjtCkmis(2)推薦使用的控件前綴控件類型前綴例子3D PanelpnlpnlGroupADO DataadoadoBiblioAnimated buttonanianiMailBoxCheck boxchkchkReadOnlyCombo box drop-down list boxcbocboEnglishCommand button

9、cmdcmdExitCommon dialogdlgdlgFileOpenCommunications comcomFaxControl (當特定類型未知時，在過程中所使用的)ctrctrCurrentDatadatdatBiblioData-bound combo boxdbcbodbcboLanguageData-bound griddbgrddbgrdQueryResultxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx（3）推薦使用的數據訪問對象的前綴用下列前綴來指示數據訪問對象。數據庫對象前綴例子ConnectionconconReportsxxxd

10、bdbAccounts一些例子：（此處加入例子）（4）推薦使用的菜單前綴應用程序頻繁使用許多菜單控件，對于這些控件具備一組唯一的命名約定很實用。除了最前面"mnu"標記以外，菜單控件的前綴應該被擴展：對每一級嵌套增加一個附加前綴，將最 終的菜單的標題放在名稱字符串的最后。下表列出了一些例子。菜單標題序列菜單處理器名稱（此處加入標題序列及處理器名稱 ）當使用這種命名約定時，一個特定的菜單組的所有成員一個接一個地列在Visual Basic的“屬性”窗口中。而且，菜單控件的名字清楚地表示出它們所屬的菜單項。（5）為其它控件選擇前綴對于上面沒有列出的控件， 應該用唯一的由兩個或三

11、個字符組成的前綴使它們標準化，以保持一致性。只有當需要澄清時，才使用多于三個字符的前綴。例如，（此處加入例子）3. 2. 2常量和變量命名約定公式：除量或變量名稱=常量或變量范圍前綴 +常量或變量類型前綴 +自定義名稱（自 定義名稱要力一定的意義且第一個字母大寫）|除了對象之外，常量和變量也需要良好格式的命名約定。本節列出了（此處加入變量列表）。變量應該總是被定義在盡可能小的范圍內。全局（Public）變量可以導致極其復雜的狀態機構，并且使一個應用程序的邏輯非常難于理解。全局變量也使代碼的重用和維護更加困難。Delphi中的變量可以有下列范圍：范圍聲明位置可見位置過程級（此處加入名稱）模塊級（

12、此處加入名稱） 全局（此處加入名稱）。較好的編碼習慣是盡可能寫模塊化的代碼。例如，如果應用程序顯示一個對話框，就把要完成這一對話任務所需要的所有控件和代碼放在單一的窗體中。這有助于將應用程序的代碼組織在有用的組件中，并減小它運行時的開銷。除了全局變量（應該是不被傳遞的），過程和函數應該僅對傳遞給它們的對象操作。在過程中使用的全局變量應該在過程起始處的聲明部分中標識出來。變量范圍前綴隨著工程大小的增長，劃分變量范圍的工作也迅速增加。在類型前綴的前面放置單字母范圍前綴標明了這種增長，但變量名的長度并沒有增加很多。范圍前綴例子全局gGstrUserName模塊級mMblnCalcInProgress

13、本地到過程無DblVelocity（此處加入說明）變量聲明所有的變量將會（此處加入說明）。應該給變量加前綴來指明它們的數據類型。而且前綴可以被擴展， 用來指明變量范圍， 特別是對大型程序。變量數據類型用下列前綴來指明一個變量的數據類型。（此處加入說明）描述變量和過程名變量或過程名的主體應該使用大小寫混合形式，并且應該足夠長以描述它的作用。而且，函數名（此處加入函數名稱）。對于頻繁使用的或長的項，推薦使用標準縮略語以使名稱的長度合理化。一般來說，（此處加入特例說明）就困難了。當使用縮略語時，要確保它們在整個應用程序中的一致性。在一個工程中，如果一會兒使用（此處加入說明問題），將導致不必要的混淆。用戶定義的類型在一項有許多用戶定義類型的大工程中，常常有必要給每種類型一個它自己的三個字符的前綴。如果這些前綴是 （此處加入 前綴名稱）。3. 2. 3結構化編碼約定（此處加入約定說明）記住下列幾點：每一個重要變量的聲明應該包括（此處加入 變量名稱）。（2）格式化代碼因為許多程序員（此處加入問題）（此處加入解決問題的 說明）（3）給常量分組變量和定義的常量應該按功能分組，而不是分散到單獨區域或特定文件中。（4）運算符（此處加入運算符列表及說明）（5）為（此處加入問題）查詢創建字符串（此處加入說明）3. 2. 4數據源的約定（