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

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