【文章內(nèi)容簡介】 實的基礎(chǔ)。 系統(tǒng)部署規(guī)范 （ 1） 系統(tǒng) 版本部署規(guī)范 定義方法： V 主版本編碼 .次版本編碼 .修正版編碼 主版本：以程序主要功能變動或三個以上功能變動作界定。 次版本：以 程序功能的變動作界定。 修正版： 以 修改程序錯誤作界定。 （ 2） 系統(tǒng)目錄部署規(guī)范 表 1 系統(tǒng)目錄部署規(guī)范 目錄 說明 Component 組件 DLL 文件 Source 代碼源文件 Config 系統(tǒng)配置文件（ ini 文件等） Image 圖片文件、圖標文件 系統(tǒng)編程規(guī)范 （ 1） 一般 常量命名規(guī)范 以大寫的實體名稱作命名，如： MAX = 100。 （ 2） 異常常量命名規(guī)范 自 定義的異常常量的命名方法（大寫）： ERR_模塊名 _異常類型 _異常名稱。異常類型如下所示： 表 2 異常常量命名規(guī)范 異常類型 說明 SYS 系統(tǒng)性異常，如： I/O 異常 MDL 模塊性異常，如：處理流程錯誤 FNT 函數(shù)異常，如：邏輯錯誤 例如： ERR_CUSTOMER_MDL_MISSNAME （ 3） 一般變量命名規(guī)范 中南大學本科生畢業(yè)設(shè)計 674fb3964f7ba9b1b239c8859fba799f 15 一般變量 命名規(guī)范為變量意義名稱 +數(shù)據(jù)類型，使用大小寫混合的英文串來構(gòu)造，構(gòu)造必須遵循見 名知義的 原則。 如 變量 RowCount_int 表示行的數(shù)量 ，該數(shù)據(jù) 類型是integer 型。 表 3 一 般常量類型命名規(guī)范 數(shù)據(jù)類型 后綴 數(shù)據(jù)類型 后綴 Sbyte sbyt Bool bln Byte byt decimal dec Short sht enum enm ushort usht object obj Int int string str Uint uint array arr Long lng date date ulong ulng time time Char chr datetime dtime Float flt Bool bln double dbl decimal dec （ 4） 異常變量命名規(guī)范 異常變量命名方法： err_異常名稱。 異常枚舉變量命名方法： enm_err_異常名稱。 （ 5） 控件變量命名規(guī)范 控件變量命名 規(guī)范為控件類型 +實體名稱，實體名稱命名規(guī)范如一般變量命名規(guī)范，即 使用大小寫混合的英文串來構(gòu)造，構(gòu)造遵循見名知義的原則。 如變量 frmSaleBill 表示銷售單窗體。 表 4 控件變量類型命名規(guī)范 控件類型 前綴 控件類型 前綴 Button Btn NotifyIcon Nin CheckBox Chk Numeric UpDow n Nud CheckedListBox Chklst OpenFileDialog Ofd ColorDialog Cld PageSetupDialog Psd ComboBox Cmb Panel Pnl ContextMenu Ctm PictureBox Ptb DataGrid Dtg PrintDialog Prd DateTimePicker Dtp PrintDocument Prc DomainUpDown Dud PrintPreview Control Ppc ErrorProvider Epd PrintPreview Dialog Ppd FontDialog Fnd ProgressBar Pgb Form Frm RadioButton Rdb 中南大學本科生畢業(yè)設(shè)計 674fb3964f7ba9b1b239c8859fba799f 16 控件類型 前綴 控件類型 前綴 GroupBox Gpb RichTextBox Rtb HelpProvider Hlp SaveFileDialog Sfd HscrollBar Hsb Splitter Spl VscrollBar Vsb StatusBar Stb ImageList Ils TabControl Tcl Label Lab TextBox Txt LinkLabel Lnk Timer Tmr ListBox Lst ToolBar Tlb ListView Lvw ToolTip Tlt MainMenu Mmu TrackBar Tkb MonthCalendar Mcl TreeView Trv （ 6） 源 代碼 格式 規(guī)范 標準的、基于制表位的嵌套塊應該被縮進四個空格（缺省情況下）。 邏輯結(jié)構(gòu)的代碼段，如果代碼段需要加上 {}，則必須按照以下方式書寫： if(True) { ?? 代碼段 } else { ?? 代碼段 } 邏輯符和運算符兩邊必須各保留一個空格。例如： Count_int = i + 3。 其他 源 代碼編寫規(guī)范遵照開發(fā)工具幫助文件中例子的格式，如 do while,for 等語句的縮進編寫格式。 （ 7） 源 代碼注釋規(guī)范 在 源 代碼中，必要的注釋對于代碼的維護起著十分重要的作用，但過多的注釋會影響 源 代碼的可閱讀性，因此應靈活掌握，但不能違背這樣一個原則，即：可使他人通過注釋基本了解代碼段的含義。 每一個重要變量的聲明應該包括一個嵌入注釋，來描述該變量的使用。 變量、控件及過程的命名應該足夠 清楚，使得只有復雜的執(zhí)行細節(jié)才需要嵌入注釋。 ● 名字空間 頭注釋塊應該包括下列節(jié)標題。 表 5 名字空間 頭注釋塊 規(guī)范 標題 注釋描述 功能 該過程完成什么（而不是怎么完成）。 中南大學本科生畢業(yè)設(shè)計 674fb3964f7ba9b1b239c8859fba799f 17 作者 代碼創(chuàng)建人 最后修改 代碼的最后修改者和修改日期 例如： //amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。 // 功能： 銷售單 組件 // 作者： jiafenglion, 20200101 // 最后修改： lion， 20200301 //amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。amp。 ● 類頭注釋塊應該包括下列節(jié)標題。 表 6 類頭注釋塊規(guī)范 標題 注釋描述 類名 該過程完成什么（而不是怎么完成）。 作者 代碼創(chuàng)建人 最后修改 代碼的最后修改者和修改日期 例如： // // 類名： 客戶類 // 作者： jiafenglion, 20200101 // 最后修改： lion， 20200301 // ● 函數(shù)頭注釋塊應該包括下列節(jié)標題。 表 7 函數(shù)頭注釋塊規(guī)范 標題 注釋描述 功能 該過程完成什么（而不是怎么完成）。 作者 代碼創(chuàng)建人 輸入 每一個可能不明顯的參數(shù)。參數(shù)分別在單獨的行上，并嵌入注釋。 返回 函數(shù)返回值的說明。 最后修改 代碼的最后修改者和修改日期 例如： //************************************************* // 功能： 在用戶列表數(shù)組中找出一個指 定用戶的第一次出現(xiàn)位置。 // 作者： jiafenglion, 20200101 // 輸入： // strUserList()： 被搜索的用戶列表。 // strTargetUser： 要搜索的用戶名。 中南大學本科生畢業(yè)設(shè)計 674fb3964f7ba9b1b239c8859fba799f 18 // 返回： 在 rasUserList 數(shù)組中 rsTargetUser 的第一次出現(xiàn)的索引。 // 如果目標用戶沒找到，返回 1。 // 最后修改： lion， 20200610 //************************************************* ● 關(guān)于 源 代碼注釋的補充說明 代碼注釋可以增強程序的可讀性。但是由于開發(fā)語言一般都是英語，中文注釋的出現(xiàn)會降低程序的書寫美感，使得程序結(jié)構(gòu)不夠同一，容易產(chǎn)生混亂與誤解。因此，對于代碼注釋的使用應當適當，而非越多越好。建議程序編寫時候嚴格遵循代碼的命名規(guī)范，盡量做到望名生義，盡量少用注釋。 數(shù)據(jù)庫設(shè)計規(guī)范 （ 1） 數(shù)據(jù)表命名規(guī)范 表 8 數(shù)據(jù)表命名規(guī)范 類型 命名方法 例子 系統(tǒng)配置表 TS_表名 TS_Operator 編碼表 TC_表名 TC_Trade 數(shù)據(jù)表 TD_表名 TD_Price 報表配置表 TR_表名 TR_BillReport 暫存表 TT_表名 TT_Temp （ 2） 視圖命名規(guī)范 命名方法： V_視圖名 ， 例子： V_Operator 。 （ 3） 字段命名規(guī)范 命名方法： F_字段名，例子： F_Id 。 （ 4） 觸發(fā)器 和 存儲過程命名規(guī)范 ● 觸發(fā)器 命名方法： Tri _觸發(fā)器類型 _觸發(fā)器名，例子： Tri_Update_Customers 。 ● 存儲過程 命名方法： Pro_存儲過程名，例子： Pro_Sell 。 （ 5） 數(shù)據(jù)庫更新修改 設(shè)計規(guī)范 數(shù)據(jù)庫設(shè)計應該在代碼編寫之前設(shè)計完成。也就是說，應該先進行系統(tǒng)整體架構(gòu)的設(shè)計，再進行代碼編寫的工作。通常我們會應用系統(tǒng)建模的工具，如 Rational、 Visual UML等進行系統(tǒng)數(shù)據(jù)庫的建模工作。 數(shù)據(jù)庫設(shè)計時應盡量地考慮 各種情況，力求做到一步到位。但是實際情況往往難以做到。一旦迫不得已要對數(shù)據(jù)庫進行修改，如增加新表、在某個表中增加或刪除某個字段等等的操作時，必需 嚴格按照數(shù)據(jù)庫更新修改設(shè)計規(guī)范進行，填寫好數(shù)據(jù)庫修改日志。數(shù)據(jù)庫修改日志的編寫將有利于日后的系統(tǒng)維護工作。團隊開發(fā)時更應該注意，各開發(fā)人 員的數(shù)據(jù)庫必須同步更新，以免造成開發(fā)混亂。 中南大學本科生畢業(yè)設(shè)計 674fb3964f7ba9b1b239c8859fba799f 19 表 9 數(shù)據(jù)庫修改日志 數(shù)據(jù)庫名稱 修改更新內(nèi)容 修改更新目的 作者 時間 如： MyDataBase 增加表： TD_Exc hangeRate 定期記錄匯率 lion 20200101 配置數(shù)據(jù)的命名規(guī)范 表 10 配置數(shù)據(jù)的命名規(guī)范 配置數(shù)據(jù)類型 命名方法 例子 系統(tǒng)性 Ass_Sys_配置名稱 Ass_Sys_Version 異常提示 Ass_Err_提示名稱 Ass_Err_EnterError 信息提示 Ass_Msg_提示名稱 Ass_Msg_SelectCustomer 系統(tǒng)界面設(shè)計規(guī)范 為了達到界面統(tǒng)一美觀并且易于修改維護的目的，系統(tǒng)的窗體設(shè)計統(tǒng)一繼承一個模版窗口 。 中南大學本科生畢業(yè)設(shè)計 674fb3964f7ba9b1b239c8859fba799f 20 第 4 章 汽車 4S 店信息系統(tǒng)設(shè)計 系統(tǒng)設(shè)計目標 長期戰(zhàn)略目標 公司企業(yè)的根本目的是實現(xiàn)效益的最大化。汽車 4S 店使用信息系統(tǒng)的目的正是如此。因此，適應激烈的市場競爭環(huán)境，滿足汽車 4S 店信息化需求，實現(xiàn)汽車 4S 店的效益最大化是本文汽車 4S 店信息系統(tǒng)設(shè)計的長期戰(zhàn)略目標。 近期預期目標 用戶對信息系統(tǒng)的需求是發(fā)展的、變化的、不確定的。本文的 汽車 4S 店信息系統(tǒng)設(shè)計本著長遠規(guī)劃，重點建設(shè)，分步實施的原則，在這次的解決方案中，一方