系統(tǒng)開(kāi)發(fā)部編程規(guī)范

1、C#書(shū)寫規(guī)范目 錄1 目的 2 范圍 3 注釋規(guī)范 3.1 概述 3.2 自建代碼文件注釋3.3 模塊（類）注釋 3.4 類屬性注釋 3.5 方法注釋 3.6 代碼間注釋 4 命名總體規(guī)則5 命名規(guī)范5.1 變量（Variable）命名 5.2 常量命名5.3 類（Class）命名 5.4 接口（Interface）命名5.5 方法（Method）命名 5.6 名稱空間(Namespace）命名 6 編碼規(guī)則6.1 錯(cuò)誤檢查規(guī)則 6.2 大括號(hào)規(guī)則 6.3 縮進(jìn)規(guī)則 6.4 小括號(hào)規(guī)則 6.5 If else規(guī)則 6.6 比較規(guī)則 6.7 Case規(guī)則 6.8 對(duì)齊規(guī)則 6.9 單語(yǔ)句規(guī)則 6

2、.10 單一功能規(guī)則 6.11 簡(jiǎn)單功能規(guī)則 6.12 明確條件規(guī)則 6.13 選用FALSE規(guī)則 6.14 獨(dú)立賦值規(guī)則 6.15 定義常量規(guī)則 6.16 模塊化規(guī)則 6.17 交流規(guī)則 7 編程準(zhǔn)則7.1 變量使用 7.2 數(shù)據(jù)庫(kù)操作 7.3 對(duì)象使用 7.4 模塊設(shè)計(jì)原則 7.5 結(jié)構(gòu)化要求 7.6 函數(shù)返回值原則 8 代碼包規(guī)范8.1 代碼包的版本號(hào) 9 代碼的控制9.1 代碼庫(kù)/目錄的建立 9.2 代碼歸檔 10 輸入控制校驗(yàn)規(guī)則10.1 登陸控制 10.2 數(shù)據(jù)錄入控制 11數(shù)據(jù)庫(kù)命名和使用規(guī)范附件1：數(shù)據(jù)類型縮寫表 附件2：服務(wù)器控件名縮寫表附件3：代碼生成器生成代碼格式1 目的

3、一. 為了統(tǒng)一公司軟件開(kāi)發(fā)設(shè)計(jì)過(guò)程的編程規(guī)范。二. 使網(wǎng)站開(kāi)發(fā)人員能很方便的理解每個(gè)目錄,變量，控件，類，方法的意義。三. 為了保證編寫出的程序都符合相同的規(guī)范，保證一致性、統(tǒng)一性而建立的程序編碼規(guī)范。四. 編碼規(guī)范和約定必須能明顯改善代碼可讀性，并有助于代碼管理、分類范圍適用于企業(yè)所有基于.NET平臺(tái)的軟件開(kāi)發(fā)工作。2 范圍本規(guī)范適用于開(kāi)發(fā)組全體人員，作用于軟件項(xiàng)目開(kāi)發(fā)的代碼編寫階段和后期維護(hù)階段。3 注釋規(guī)范3.1 概述 注釋要求寫清楚作者，時(shí)間，功能描述，參數(shù)描述，返回?cái)?shù)據(jù)。 注釋中，應(yīng)標(biāo)明對(duì)象的完整的名稱及其用途，但應(yīng)避免對(duì)代碼過(guò)于詳細(xì)的描述。 每行注釋的最大長(zhǎng)度為100個(gè)字符。 將注

4、釋與注釋分隔符用一個(gè)空格分開(kāi)。 不允許給注釋加外框。 編碼的同時(shí)書(shū)寫注釋。 重要變量必須有注釋。 變量注釋和變量在同一行，所有注釋必須對(duì)齊，與變量分開(kāi)至少四個(gè)“空格”鍵。 如: int m_intLevel,m_intCount; /注釋 string m_strSql; /注釋 典型算法必須有注釋。 在循環(huán)和邏輯分支地方的上行必須就近書(shū)寫注釋。 程序段或語(yǔ)句的注釋在程序段或語(yǔ)句的上一行 在代碼交付之前，必須刪掉臨時(shí)的或無(wú)關(guān)的注釋。 為便于閱讀代碼，每行代碼的長(zhǎng)度應(yīng)少于100個(gè)字符。3.2 自建代碼文件注釋對(duì)于自己創(chuàng)建的腳本代碼文件（函數(shù)），在文件開(kāi)頭，一般編寫如下注釋,在項(xiàng)目上線時(shí)把有注釋文

5、件備份后刪除注釋上線：/ 作者：作者中文名/ 創(chuàng)建日期：YYYY-MM-DD/ 功能描述：對(duì)該方法的說(shuō)明/ 參數(shù)說(shuō)明：傳入?yún)?shù)/ 返回?cái)?shù)據(jù)說(shuō)明：3.3 模塊（類）注釋模塊開(kāi)始必須以以下形式書(shū)寫模塊注釋：(盡量使用代碼生成器來(lái)生成類，這樣風(fēng)格就比較統(tǒng)一)/ 創(chuàng)建者: / 創(chuàng)建時(shí)間:2008-02-29/ 修改者: / 修改時(shí)間: / 修改內(nèi)容: / 類功能: /3.4 類屬性注釋在類的屬性必須以以下格式編寫屬性注釋：/ / / 3.5 方法注釋在類的方法聲明前必須以以下格式編寫注釋/ / 作者： 作者中文名/ 創(chuàng)建日期：YYYY-MM-DD/ 功能描述：該方法的說(shuō)明/ / param name=

6、參數(shù)說(shuō)明/ / 3.6 代碼間注釋代碼間注釋分為單行注釋和多行注釋：/*多行注釋1多行注釋2多行注釋3*/代碼中遇到語(yǔ)句塊時(shí)必須添加注釋（if,for,foreach,）,添加的注釋必須能夠說(shuō)明此語(yǔ)句塊的作用和實(shí)現(xiàn)手段（所用算法等等）。4 命名總體規(guī)則 名字應(yīng)該能夠標(biāo)識(shí)事物的特性。 名字一律使用英文單詞，而不能為拼音。 名字盡量不使用縮寫，除非它是眾所周知的。 名字可以有兩個(gè)或三個(gè)單詞組成，但不應(yīng)多于三個(gè)，控制在3至30個(gè)字母以內(nèi)。 在名字中，多個(gè)單詞用大寫第一個(gè)字母（其它字母小寫）來(lái)分隔。例如：IsSuperUser。 名字盡量使用前綴而不是后綴。 名字中的單詞盡量使用名詞，如有動(dòng)詞，也盡量

7、放在后面。例如：FunctionUserDelete（而不是FunctionDeleteUser）。5 命名規(guī)范5.1 變量（Variable）命名 程序文件(*.cs)中的變量命名,程序中變量名稱 = 變量的前綴 +代表變量含意的英文單詞或單詞縮寫。 類模塊級(jí)的變量請(qǐng)用“m_” +數(shù)據(jù)類型縮寫作為前綴（其中，m 為“memory”縮寫，數(shù)據(jù)類型縮寫見(jiàn)附件中的數(shù)據(jù)類型縮寫表）。 public class hello private string m_strName; private DateTime m_dtmDate; 類的屬性所對(duì)應(yīng)的變量，采用屬性名前加“m_”+ 類型縮寫 前綴的形式.p

8、ublic class hello private string m_strName; public string strName get return m_strName; 函數(shù)級(jí)的變量使用類型縮寫前綴public class hello void say() string strSayWord; 函數(shù)中的參數(shù)使用“p_”+ 類型縮寫作為前綴（其中，p 為“parameter”縮寫）public class Test private void say(string p_strSayWord ) 類模塊級(jí)的全局變量用“g_”+類型縮寫作為前綴（其中，g 為“global”縮寫）public c

9、lass Test public string g_strUserName; private void say(string p_strSayWord ) 補(bǔ)充說(shuō)明：針對(duì)異常捕獲過(guò)程中的Exception變量命名，在沒(méi)有沖突的情況下，統(tǒng)一命名為exp；如果有沖突的情況下，可以用“exp”+ 標(biāo)志名稱，如：expSql。Try /your codetry /codecatch(Exception exp) /your codecatch(Exception expSql) /your code補(bǔ)充：如果捕獲異常不需要作任何處理，則不需要定義Exception實(shí)例。例：try /your code

10、catch( Exception exp)其他說(shuō)明： 在工程設(shè)置中我們將起用生成XML文檔文件，并且我們?cè)谡{(diào)試中不能夠看見(jiàn)警告，這樣能夠確保所有的需要注釋的地方不遺漏。5.2 常量命名常量名也應(yīng)當(dāng)有一定的意義，格式為 C_前綴后面在加符合意思的名稱，如C_AUTHEN。常量名均為大寫，字之間用下劃線分隔。例：private const bool C_ISINBOX = true;private const int C_JOBCOUNT = 3600;private const bool C_ISPOST = false;5.3 類（Class）命名 名字應(yīng)該能夠標(biāo)識(shí)事物的特性,在事物邏輯層添加

11、BLL前綴，方便WEB層調(diào)用提示和明確意思。名字盡量不使用縮寫，除非它是眾所周知的（長(zhǎng)用縮寫如 informationinfo;customerctm .）。名字可以有兩個(gè)或三個(gè)單詞組成，但通常不應(yīng)多于三個(gè)(CurrentUserInfo)。在名字中，所有單詞第一個(gè)字母大寫。例如 IsSuperUser，包含ID的，ID全部大寫，如CustomerID。使用名詞或名詞短語(yǔ)命名類。 不要使用下劃線字符 (_)。 例： public class FileStream public class Customer public class BLLUser5.4 接口（Interface）命名和類命名規(guī)

12、范相同，唯一區(qū)別是 接口在名字前加上“I”前綴例：interface IDBCommand;interface IButton;5.5 方法（Method）命名和類命名規(guī)范相同。5.6 命名空間（NameSpace）命名和類命名規(guī)范相同。6 編碼規(guī)則6.1 錯(cuò)誤檢查規(guī)則 編程中要考慮函數(shù)的各種執(zhí)行情況，盡可能處理所有流程情況。 檢查所有的系統(tǒng)調(diào)用的錯(cuò)誤信息，除非要忽略錯(cuò)誤。 將函數(shù)分兩類：一類為與屏幕的顯示無(wú)關(guān)， 另一類與屏幕的顯示有關(guān)。對(duì)于與屏幕顯示無(wú)關(guān)的函數(shù)，函數(shù)通過(guò)返回值來(lái)報(bào)告錯(cuò)誤（用返回的錯(cuò)誤號(hào)，用整數(shù)來(lái)表示）。對(duì)于與屏幕顯示有關(guān)的函數(shù)，函數(shù)要負(fù)責(zé)向用戶發(fā)出警告，并進(jìn)行錯(cuò)誤處理。 錯(cuò)誤

13、處理代碼一般放在函數(shù)末尾。 對(duì)于通用的錯(cuò)誤處理，可建立通用的錯(cuò)誤處理函數(shù)，處理常見(jiàn)的通用的錯(cuò)誤。6.2 大括號(hào)規(guī)則將大括號(hào)放置在關(guān)鍵詞下方的同列處，例如：if ($condition) /your code 6.3 縮進(jìn)規(guī)則使用一個(gè)“Tab”為每層次縮進(jìn)。例如：function func() if (something bad)if (another thing bad) while (more input) 6.4 小括號(hào)規(guī)則 不要把小括號(hào)和關(guān)鍵詞（if 、while等）緊貼在一起，要用空格隔開(kāi)它們。 不要把小括號(hào)和函數(shù)名緊貼在一起。 除非必要，不要在Return返回語(yǔ)句中使用小括號(hào)。因?yàn)殛P(guān)

14、鍵字不是函數(shù)，如果小括號(hào)緊貼著函數(shù)名和關(guān)鍵字，二者很容易被看成是一體的。6.5 if else規(guī)則如果你有用到else if 語(yǔ)句的話，通常最好有一個(gè)else塊以用于處理未處理到的其他情況?？梢缘脑挿乓粋€(gè)記錄信息注釋在else處，即使在else沒(méi)有任何的動(dòng)作。其格式為：if (條件1) /注釋else if (條件2) /注釋else /注釋注：if 和循環(huán)的嵌套最多允許4層6.6 比較規(guī)則 總是將恒量放在等號(hào)/不等號(hào)的左邊。一個(gè)原因是假如你在等式中漏了一個(gè)等號(hào)，語(yǔ)法檢查器會(huì)為你報(bào)錯(cuò)。第二個(gè)原因是你能立刻找到數(shù)值而不是在你的表達(dá)式的末端找到它。例如：if ( 6 = errorNum ) .6

15、.7 Case規(guī)則 default case總應(yīng)該存在，如果不允許到達(dá)，則應(yīng)該保證：若到達(dá)了就會(huì)觸發(fā)一個(gè)錯(cuò)誤。Case的選擇條件最好使用int或string類型。6.8 對(duì)齊規(guī)則 變量的申明和初始化都應(yīng)對(duì)齊并且集中放置。例如：private int m_intCount;private int m_intResumeCountprivate float m_fIncome,m_fPay; m_intCount = 0;m_intResumeCount = 1;m_fIncome = 0.3;6.9 單語(yǔ)句規(guī)則 除非這些語(yǔ)句有很密切的聯(lián)系，否則每行只寫一個(gè)語(yǔ)句。6.10 單一功能規(guī)則 原則上，一

16、個(gè)程序單元（函數(shù)、例程、方法）只完成一項(xiàng)功能。6.11 簡(jiǎn)單功能規(guī)則 原則上，一個(gè)程序單元的代碼應(yīng)該限制在一頁(yè)內(nèi)（2530行）。6.12 明確條件規(guī)則 不要采用缺省值測(cè)試非零值。例如：使用“if ( 0 != f( ) )”而不用“if ( f( ) )”。6.13 選用FALSE規(guī)則 大 部分函數(shù)在錯(cuò)誤時(shí)返回FALSE、0或NO之類的值，但在正確時(shí)返回值就不定了（不能用一個(gè)固定的TRUE、1或YES來(lái)代表），因此檢測(cè)一個(gè)布爾值時(shí)應(yīng) 該用 FALSE、0、NO之類的不等式來(lái)代替。例如：使用“if ( FALSE != f( ) )” 而不用“if (TRUE = f( ) )”。6.14 獨(dú)立

17、賦值規(guī)則 嵌入式賦值不利于理解程序，同時(shí)可能會(huì)造成意想不到的副作用，應(yīng)盡量編寫?yīng)毩⒌馁x值語(yǔ)句。例如：使用“a = b + c ; e = a + d;”而不用“e = ( a = b + c ) + d ”。6.15 定義常量規(guī)則 對(duì)于代碼中引用的常量（尤其是數(shù)字），應(yīng)該define成一個(gè)大寫的名字，在代碼中引用名字而不直接引用值。6.16 模塊化規(guī)則 某一功能，如果重復(fù)實(shí)現(xiàn)一遍以上，即應(yīng)考慮模塊化，將它寫成通用函數(shù)。并向小組成員發(fā)布。同時(shí)要盡可能利用其它人的現(xiàn)成模塊。6.17 交流規(guī)則 共享別人的工作成果，向別人提供自己的工作成果。在具體任務(wù)開(kāi)發(fā)中，如果有其它的編碼規(guī)則，則在相應(yīng)的軟件開(kāi)發(fā)計(jì)

18、劃中予以明確定義。 7 編程準(zhǔn)則7.1 變量使用 不允許隨意定義全局變量。 一個(gè)變量只能有一個(gè)用途；變量的用途必須和變量的名稱保持一致。 所有變量都必須在類和函數(shù)最前面定義，并分類排列。7.2 數(shù)據(jù)庫(kù)操作 查找數(shù)據(jù)庫(kù)表或視圖時(shí)，只能取出確實(shí)需要的那些字段，不需要的一定不要取。 關(guān)聯(lián)查詢盡量不查詢顯示字段，而查詢主鍵（用主鍵查詢的方式IN來(lái)獲取詳細(xì)信息字段或者一條一條記錄來(lái)獲取顯示字段），不需要關(guān)聯(lián)的查詢盡量不去聯(lián)表，在網(wǎng)才項(xiàng)目中已經(jīng)實(shí)踐過(guò)，這樣效率會(huì)有很大的提升。 清楚明白地使用列名，而不能使用列的序號(hào)；我們?cè)陂_(kāi)發(fā)過(guò)程中使用列名大寫，代碼生成器在獲取系統(tǒng)表中的字段名稱是大寫的，我們?yōu)榱私y(tǒng)一代碼

19、風(fēng)格。 涉及到數(shù)據(jù)字典的字段全部放到頁(yè)面統(tǒng)一翻譯，不在數(shù)據(jù)獲取是翻譯。 需要數(shù)據(jù)完整性的情況，一定要使用事務(wù)。7.3 對(duì)象使用 盡可能晚地創(chuàng)建對(duì)象，并且盡可能早地釋放它（一般在調(diào)用的時(shí)候再去創(chuàng)建對(duì)象，盡量不要做全局的變量）。7.4 模塊設(shè)計(jì)原則 不允許隨意定義公用的函數(shù)和類，系統(tǒng)中在邏輯工程和WEB工程中各有一個(gè)基類，注意基類中的公用函數(shù)的公用性的界定（如權(quán)限的檢查，用戶有效性判斷等函數(shù)放到公用類中）。 函數(shù)功能單一，不允許一個(gè)函數(shù)實(shí)現(xiàn)兩個(gè)及兩個(gè)以上的功能。 不能在函數(shù)內(nèi)部使用全局變量，如要使用全局變量，應(yīng)轉(zhuǎn)化為局部變量(確保不混用)。 函數(shù)與函數(shù)之間只允許存在包含關(guān)系，而不允許存在交叉關(guān)系。

20、即兩者之間只存在單方向的調(diào)用與被調(diào)用，不存在雙向的調(diào)用與被調(diào)用。7.5 結(jié)構(gòu)化要求 禁止出現(xiàn)兩條等價(jià)的支路。例如：if (a = 2)else if (a= 3)/else if (a = 2)/else/ 避免使用GOTO語(yǔ)句。 用 IF 語(yǔ)句來(lái)強(qiáng)調(diào)只執(zhí)行兩組語(yǔ)句中的一組。禁止 ELSE GOTO 和 ELSE RETURN。 用 CASE 實(shí)現(xiàn)多路分支。 避免從循環(huán)引出多個(gè)出口。在分支中給變量賦值在函數(shù)最后再返回。 函數(shù)只有一個(gè)出口。 不使用條件賦值語(yǔ)句。 函數(shù)過(guò)長(zhǎng)時(shí)候盡量在邏輯完整的情況下拆分多個(gè)函數(shù)。 不要輕易用條件分支去替換邏輯表達(dá)式。7.6 函數(shù)返回值原則 函數(shù)返回值避免使用結(jié)構(gòu)體

21、等復(fù)雜類型使用bool類型：該函數(shù)只需要獲得成功或者失敗的返回信息時(shí)候使用int 類型： 錯(cuò)誤代碼用負(fù)數(shù)表示，成功返回0,對(duì)編號(hào)賦予特殊意義。8 代碼包規(guī)范本項(xiàng)目中，每個(gè)任務(wù)在完成一個(gè)穩(wěn)定的版本后，都應(yīng)打包并且歸檔。8.1 代碼包的版本號(hào)項(xiàng)目中，代碼包的版本號(hào)由圓點(diǎn)隔開(kāi)的兩個(gè)數(shù)字組成，第一個(gè)數(shù)字表示發(fā)行號(hào)，第二個(gè)數(shù)字表示該版的修改號(hào)。具體用法如下： 當(dāng)代碼包初版時(shí)，版本號(hào)為 V1.00； 當(dāng)代碼包被局部修改或bug修正時(shí)，發(fā)行號(hào)不變，修改號(hào)第二個(gè)數(shù)字增1。例如，對(duì)初版代碼包作了第一次修訂，則版本號(hào)為 V1.01； 當(dāng)代碼包在原有的基礎(chǔ)上增加部分功能，發(fā)行號(hào)不變，修改號(hào)第一個(gè)數(shù)字增1，例如，對(duì)V

22、1.12版的基礎(chǔ)上增加部分功能，則新版本號(hào)為 V1.20； 當(dāng)代碼包有重要修改或局部修訂累積較多導(dǎo)致代碼包發(fā)生全局變化時(shí)，發(fā)行號(hào)增1。例如，在 V1.15 版的基礎(chǔ)上作了一次全面修改，則新版本號(hào)為 V2.00。9 代碼的控制9.1 代碼庫(kù)/目錄的建立項(xiàng)目負(fù)責(zé)人在VSS中建立項(xiàng)目的文檔庫(kù)目錄，即為“Software”目錄，以便快速查詢。9.2 代碼歸檔所有代碼在完成一個(gè)穩(wěn)定的版本后，項(xiàng)目負(fù)責(zé)人都應(yīng)打包后，存放于VSS中該目的“Software”目錄下，并且依據(jù)代碼包的命名規(guī)范為代碼包分配一個(gè)唯一名稱。10 輸入控制校驗(yàn)規(guī)則10.1 登陸控制用戶登陸ID和登陸密碼，要限定輸入長(zhǎng)度范圍，必須檢查輸入

23、合法性。10.2 數(shù)據(jù)錄入控制 TextBox輸入。 1、 要保持用戶輸入和數(shù)據(jù)庫(kù)接收的長(zhǎng)度一致。 2、 必須進(jìn)行輸入合法性校驗(yàn)v 如： E_mail格式 XXXXXX.XXX。 電話格式 020- (020)。 郵政編碼是六位。 除CheckBox、LinkButton外，禁止在DataGrid內(nèi)嵌入其他編輯控件，用以添加編輯數(shù)據(jù) 。11. 數(shù)據(jù)庫(kù)命名和使用規(guī)范Oracle命名規(guī)范系統(tǒng)遵循以下命名規(guī)范： 表命名：為S_開(kāi)頭 如 S_JOBS 。 存儲(chǔ)過(guò)程命名: 為P_如 P_UserLogin。注意最好在存儲(chǔ)過(guò)程中的參數(shù)為大寫（代碼生成器抓取的是系統(tǒng)表中的參數(shù)名稱，參數(shù)名稱為大寫）。 在調(diào)用

24、底層數(shù)據(jù)庫(kù)基類時(shí)候，注意一定要使用變量帶參的方式，這樣才能減少Oracle的執(zhí)行計(jì)劃，提高數(shù)據(jù)庫(kù)的執(zhí)行效率。附件1：常用數(shù)據(jù)類型縮寫表類型前綴示例Array arrarrShoppingListBooleanblnblnIsPostBackBytebytbytPixelValueCharchrchrDelimiterDateTimedtmdtmStartDateDecimaldecdecAverageHeightDoubledbldblSizeofUniverseHashtablehashasWhereLong lnglngBillGatesIncomeObject objobjReturnValueShortshrshrAverageSingle sngsngMaximumString strstrFirstNameDateTabledtbdtbJobs附注：數(shù)據(jù)庫(kù)服務(wù)器命名規(guī)范，控件名縮寫+控件作用單詞的全稱,如：btnNext, txtPassword(密碼文本框)，txtRPassword(密碼確認(rèn)文本框)，單詞的第一個(gè)字母必須大寫如果有多個(gè)