【正文】 10. 數(shù)據(jù)庫(kù)設(shè)計(jì)詳見[xxx數(shù)據(jù)庫(kù)設(shè)計(jì)說明書]如果數(shù)據(jù)庫(kù)設(shè)計(jì)內(nèi)容比較少，則直接在此處描述。獨(dú)立的要被應(yīng)用其他功能所調(diào)用的模塊的接口和公共API的注釋要完備，即包括功能說明、參數(shù)和返回值說明。 不要用工具生成沒用的注釋。(6) 接口（Interface）命名規(guī)范和類命名規(guī)范相同，唯一區(qū)別是 接口在名字前加上“I”前綴。） 源程序文件說明給出本程序的各源程序文件的說明，包括源程序文件名稱及其所在目錄，功能說明，包含的前導(dǎo)文件及函數(shù)名稱等。 輸入數(shù)據(jù)詳細(xì)描述用戶輸入的數(shù)據(jù)(包括任何輸入設(shè)備)以及這些數(shù)據(jù)的有效性檢驗(yàn)規(guī)則。此為詳細(xì)設(shè)計(jì)的主要部分之一。 術(shù)語表定義系統(tǒng)或產(chǎn)品中涉及的重要術(shù)語，為讀者在閱讀文檔時(shí)提供必要的參考信息。5. 全局?jǐn)?shù)據(jù)結(jié)構(gòu)說明本章說明本程序系統(tǒng)中使用的全局?jǐn)?shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。 外部界面設(shè)計(jì)根據(jù)系統(tǒng)界面劃分進(jìn)行系統(tǒng)外部界面設(shè)計(jì)，對(duì)系統(tǒng)的所有外部接口（包括功能和數(shù)據(jù)接口）進(jìn)行設(shè)計(jì)。 子模塊1 設(shè)計(jì)圖 功能描述簡(jiǎn)要描述子模塊1的業(yè)務(wù)功能。(1) 不要給類名加前綴。178。178。 (2) 要用名詞詞組來給類型命名。詳細(xì)描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條件。 用戶界面設(shè)計(jì)規(guī)定人機(jī)界面的內(nèi)容、界面風(fēng)格、調(diào)用方式等，包括所謂的表單設(shè)計(jì)、報(bào)表設(shè)計(jì)和用戶需要的打印輸出等設(shè)計(jì)。 變量本章說明本程序系統(tǒng)中使用的全局?jǐn)?shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。本詳細(xì)設(shè)計(jì)說明書編寫的目的是說明程序模塊的設(shè)計(jì)考慮，包括程序描述、輸入/輸出、算法和流程邏輯等，為軟件編程和系統(tǒng)維護(hù)提供基礎(chǔ)。劃分系統(tǒng)功能模塊或子系統(tǒng)（如果有或者有必要，特別是大型的軟件系統(tǒng)）。 production environment: OS, database .net framwork Windwos 2003, iis , MySQL, 8. 模塊設(shè)計(jì) 用例圖 功能設(shè)計(jì)說明 模塊1模塊1主要分為以下幾個(gè)子模塊：子模塊子模塊2和子模塊N。 數(shù)據(jù)設(shè)計(jì)給出本程序中的局部數(shù)據(jù)結(jié)構(gòu)說明，包括數(shù)據(jù)結(jié)構(gòu)名稱，功能說明，具體數(shù)據(jù)結(jié)構(gòu)說明（定義、注釋設(shè)計(jì)、取值）等。 (4) 基類CBase的文件名為：。 一些常識(shí)性代碼，不需要寫沒必要的注釋。178。錯(cuò)誤界面樣式如下圖所示：錯(cuò)誤提示界面14. 設(shè)計(jì)和開發(fā)規(guī)范【可以列表方式列出設(shè)計(jì)開發(fā)的參考文檔的索引，內(nèi)容較少/關(guān)鍵內(nèi)容可以章節(jié)方式填寫】 數(shù)據(jù)庫(kù)設(shè)計(jì)規(guī)范【參見《XXXX數(shù)據(jù)庫(kù)設(shè)計(jì)規(guī)范》】 .NET編碼規(guī)范特別強(qiáng)調(diào)：178。） 源程序文件說明給出本程序的各源程序