軟件開發(fā)規(guī)范：編碼規(guī)范

軟件開發(fā)規(guī)范：編碼規(guī)范C#編碼規(guī)范目標：1.安全：代碼完成所需的功能之余,不要產(chǎn)生負作用，即要穩(wěn)定可靠。2.易讀:類、實例、成員變量、成員函數(shù)的命名一目了然3.美觀:盡量統(tǒng)一項目組內(nèi)人員的編程風格。第一部分：命名1.命名原則1)所有的函數(shù)（變量/類/文件名）應該代表其實際的作用，應該使用有意義的單詞或多個詞組合，但不要使用人名、項目組名。2)所有的函數(shù)（變量/類名）一律使用英文。3)使用多個單詞時不需要使用連線(如下劃線),但對于全部大寫的宏需要使用連線。4)多個詞組合較長時,可以使用單詞的縮寫。5)不得使用非常相近的名字類表示幾個不同含義的函數(shù)（變量/類）。6)命名時請考慮名字的唯一性和含義的準確性。7)使用項目組專用詞匯來表達特定的含義(概念),不得把專用詞匯挪作他用。2.變量的命名原則:使用匈牙利命名法命名變量1)變量名一般由“類型修飾＋代表變量含意的英文單詞或單詞縮寫”等部分組成。類型修飾(小寫字母)：n:int，l:LONG/long，s:short，u:UINT，f:floatb:bool，by:BYTE，ch:char，sz:char[],str:string2)針對異常捕獲過程中的Exception變量命名，在沒有沖突的情況下，統(tǒng)一命名為e；如果有沖突的情況下，可以重復e，比如：ee。3.函數(shù)的命名1)使用動賓詞組表達函數(shù)實際所作的事。2)同名的函數(shù)(重載函數(shù))在功能上應該完全相同,在參數(shù)上的差別也應一目了然。3)不得出現(xiàn)名字非常相近但功能不同的函數(shù).如CreatePage1(),CreatePage2()等。4.類命名1)名字應該能夠標識事物的特性。2)名字盡量不使用縮寫，除非它是眾所周知的。3)名字可以有兩個或三個單詞組成，但通常不應多于三個。4)在名字中，所有單詞第一個字母大寫，縮寫都要大寫。5.控件命名規(guī)則5)不要使用下劃線字符(_)。1)控件命名=Web控件縮寫前綴+“_”+變量名控件LabelTextBoxButtonListBoxDropDownList等等縮寫lb_XXXtb_XXXBtn_XXXLb_XXXDrd_XXXXXXXX6.文件命名1)文件起名要有實際意義。6)文件頭部應有注釋，簡單描述文件的內(nèi)容7)對于程序中的比較關鍵的算法和函數(shù)，必須加注釋3．cs文件的書寫1)各個部分應使用注釋行和空行分割,并在必要的地方寫上注釋2)函數(shù)之間用注釋行和空行分割3)重要的函數(shù)在函數(shù)頭部加上注釋4){和}分別單獨占用一行,且上下對齊,中間的內(nèi)容縮進一個TAB第三部分：其他1.變量1)float和bool禁止用"=="判斷。bool應該用邏輯運算關系符，而float應該用差值區(qū)間來判斷“相等”2)類型轉換一律用顯式類型轉換3)類型的長度一律用sizeof()獲得4)當聲明一個變量時，務必要自己初始化一下變量2.函數(shù)1)功能要單一，函數(shù)名要名符其實2)要易懂，實現(xiàn)時不要過分追求技巧，優(yōu)化放到后面去做3)長度一般禁止超過200行4)要檢查輸入值是否合法。實現(xiàn)(成員)函數(shù)時務必要求輸入?yún)?shù)是在要求范圍之內(nèi)，尤其你定義的(成員)函數(shù)給別人調(diào)用時，要判斷其合法性。5)調(diào)用函數(shù)時要嚴格按照接口規(guī)范調(diào)用，調(diào)用后要判斷執(zhí)行情況，并做適當?shù)腻e誤處理（稍后會給出錯誤和異常處理規(guī)范）。6)盡量避免整塊復制代碼段，如果出現(xiàn)這樣的情況要分析原因，如果這段代碼完成獨立的功能，應考慮使用函數(shù)，否則，應考慮使用宏定義。否則因為修改引起的不一致往往是錯誤的根源。7)除極其簡單的函數(shù)外，其他的函數(shù)在入口處必須加上FMAT_TRACE(),參見錯誤和異常處理規(guī)范。8)函數(shù)的出口盡量唯一，最好在出口處加上FMAT_TRACE()9)寫代碼時，盡量減少堆的分配次數(shù)，能使用Stack的盡量