程序設(shè)計(jì)規(guī)范文檔

1、商匯系統(tǒng)程序設(shè)計(jì)規(guī)范文檔簡述：1，所有名字統(tǒng)一通過對英文的縮寫或者組合來表達(dá)。(注：UCP是UnifiedCommunicationPlatfm的縮寫)，數(shù)據(jù)庫操作使用存儲過程，客戶端代碼請使用JQuery或者.AJAX框架來實(shí)現(xiàn)，文本均需寫進(jìn)資源文件里邊，module的樣式盡量使用dotnuk的default.css中已經(jīng)定義的，如須使用自己的樣式文件，請?jiān)诒緈odule的根目錄下建立module.css文件，并將樣式定義放入其中，樣

2、式定義命名規(guī)則如附錄四：附錄四：CSSCSS類及類及idid中的命名規(guī)則中的命名規(guī)則2，目錄結(jié)構(gòu)要求按照dotnukeModule的目錄結(jié)構(gòu)要求規(guī)范化，如：資源文件放到本Module的子目錄App_LocalResources下，資源文件名為對應(yīng)x名稱”.”zhcn.resx，邏輯代碼應(yīng)該規(guī)范在邏輯層文件中（CBO，Controller，CentralizedCustomBusinessObjectHydration），數(shù)據(jù)庫訪問層以P

3、rovider的設(shè)計(jì)模式實(shí)現(xiàn)，表現(xiàn)層要求實(shí)現(xiàn)樣式和內(nèi)容分離，提示性字符串要求寫到資源文件中。3，Module間需要做到獨(dú)立性強(qiáng)，Module間的聯(lián)系盡量通過配置的方式來實(shí)現(xiàn)。4，名字空間（Namespace）規(guī)則，名字空間的命名規(guī)則遵循DNN對module的命名規(guī)則，采用公司名稱（或者項(xiàng)目名稱）“.”Modules“.”模塊名“.”功能名例如個(gè)人資料Module的名字空間（Namespace）的命名規(guī)則如下：UCP.Modules.Pr

4、ofile.EditProfileUCP.Modules.Profile.ViewProfileUCP.Modules.Profile.Settings5，其它module請參考該命名規(guī)則a)程序集命名規(guī)則為避免代碼沖突現(xiàn)將本系統(tǒng)程序集名稱規(guī)范如下。例如個(gè)人資料Module的程序集名稱為：UCP.Modules.Profile.dll.b)類，變量、方法、以及屬性類，量、方法和屬性的名稱的第一個(gè)字母須大寫，并且名稱應(yīng)該能表達(dá)出它們的用途

5、（或者說是意義）。如：變量“員工名稱”，其在程序中的變量名稱須為：EmployeeName，變量“字節(jié)數(shù)”，其在程序中的名稱須為：NumberOfBytes等等。方法“添加數(shù)據(jù)”的名稱須為：AddData（），動(dòng)詞（Add）動(dòng)詞對象名稱（Data）使用Pal大寫方式，用逗號分隔邏輯成分。例如：例如：Microsoft.Office.PowerPoint如果你的品牌使用的是非傳統(tǒng)大寫方式，那么一定要遵循你的品牌所確定使用的大寫方式，即使這

6、種方式背離了通常的名稱空間大寫規(guī)則。例如：例如：NeXT.WebObjectsee.cummings類和類成分的命名類和類成分的命名類的命名原則是用名詞或名詞短語命名類，使用Pal大寫。減少類名中縮寫的使用量。不要使用任何類前綴（比如C），不要使用帶下劃線的字符。例如：例如：publicclassFileStreampublicclassButtonpublicclassString變量的命名變量的命名名稱中各單詞首字母均為大寫。例如：

7、例如：FindLastRecdRedrawMyFm在內(nèi)部范圍中避免使用與外部范圍中的名稱相同的名稱。若訪問錯(cuò)誤變量，則會產(chǎn)生錯(cuò)誤結(jié)果。若變量與同一名稱的關(guān)鍵字沖突，則必須在關(guān)鍵字前加適當(dāng)?shù)念愋蛶煲宰鳂?biāo)識。例如：例如：若有一個(gè)名為date的變量，只能通過調(diào)用System.DateSystem.Date來使用內(nèi)部DateDate函數(shù)。函數(shù)和方法的命名函數(shù)和方法的命名函數(shù)和方法的命名應(yīng)該以動(dòng)詞開始，使用Pal大寫。不要使用帶下劃線的字符。例如

8、：例如：InitNameArrayCloseDialog接口命名原則接口命名原則使用名詞或名詞短語，或者描述行為的形容詞來命名接口使用Pal大寫。減少接口名中縮寫的使用量，在接口名前加前綴I，以表示這個(gè)類型是一個(gè)接口。例如：例如：IComponent（描述性名詞）ICustomAttributeProvider（名詞短語）IPersistable（形容詞）參數(shù)的命名參數(shù)的命名使用描述性參數(shù)名。參數(shù)名應(yīng)該具有足夠的描述性，這樣在大多數(shù)情況