建站
咨詢
售后
建站咨詢
新聞中心
C#語言規(guī)范——注釋規(guī)范
a）文件頭部注釋
【規(guī)則1-1】文件都包含文件頭，要說明文件名、作者、創(chuàng)建時(shí)間、變更記錄。
【規(guī)則1-2】推薦采用.NET形式書寫頭部注釋。
b）類及其成員注釋
【規(guī)則2-1】對(duì)方法和類使用“///”三斜線注釋。
【規(guī)則2-2】代碼行文注釋采用“//”和“”進(jìn)行， 應(yīng)該盡量說明問題。
C#語言規(guī)范——行文規(guī)范
a）縮寫規(guī)范
【規(guī)則1-1】標(biāo)識(shí)符應(yīng)當(dāng)直觀可望文知意，不提倡使用任何縮寫。
【規(guī)則1-2】字符串變量推薦是用“str”或“s”開頭，采用string.Empty來初始化。
【規(guī)則1-3】普通對(duì)象可以以“obj”開頭。
【規(guī)則1-4】縮寫可自行定義，一般取單詞的前/后字符組成，以含義直觀為準(zhǔn)則。
【規(guī)則1-5】一般情況下不要讓縮寫破壞標(biāo)識(shí)符的含義。
b）排版
【規(guī)則2-1】每行語句至少占一行，如果語句過長（超過一屏），則該語句斷為兩行顯示。
【規(guī)則2-2】把相似的內(nèi)容放在一起，比如字段、屬性、方法、事件等，使用“#region--#endregion”命令分組。
【規(guī)則2-3】多個(gè)程序元素進(jìn)行對(duì)等操作是，操作符之前、之后或者前后都要加空格。
【規(guī)則2-4】每個(gè)方法的源程序行數(shù)原則上應(yīng)該少于200行。
【規(guī)則2-5】語句嵌套層次不得超過3層。
【規(guī)則2-6】避免相同的代碼段在多個(gè)地方出現(xiàn)。
c）語句結(jié)構(gòu)
【規(guī)則3-1】如果使用了異常結(jié)構(gòu)，一定要處理異常，一般是要寫日志文件。
【規(guī)則3-2】分支語句不應(yīng)該使用復(fù)雜長條件，應(yīng)該將長條件封裝成方法。
【規(guī)則3-3】switch語句，case后面必須接break。
【規(guī)則3-4】禁止使用goto語句進(jìn)行跳轉(zhuǎn)。
【規(guī)則3-5】行文中嚴(yán)禁出現(xiàn)“魔數(shù)”，特定含義的常數(shù)必須定義成枚舉或常量。
【規(guī)則3-6】不同類型的操作符混合使用時(shí)，使用括號(hào)給出優(yōu)先級(jí)。
【規(guī)則3-7】不允許使用復(fù)雜的操作符組合等。
【規(guī)則3-8】循環(huán)、判斷語句的程序塊部分用花括號(hào)括起來，即使只有一條語句。
【規(guī)則3-9】在switch語句中總是要有default字句，建議使用斷言。
【規(guī)則3-10】每個(gè)類和方法完成單一的功能，不設(shè)計(jì)多用途面面俱到的類或方法。
【規(guī)則3-11】嚴(yán)禁使用未經(jīng)初始化的變量，變量通常使用構(gòu)造方法來初始。
d）代碼縮進(jìn)
【規(guī)則4-1】碰到大括號(hào)要換行。
【規(guī)則4-2】不允許使用Java中的括號(hào)換行規(guī)范。
e）大小寫
【規(guī)則5-1】不要?jiǎng)?chuàng)建名稱相同，但大小寫區(qū)別的任何元素。
【規(guī)則5-2】應(yīng)當(dāng)大寫僅有兩個(gè)字符的縮寫。
【規(guī)則5-3】不要把易混淆的數(shù)字和字符放在一起。
【規(guī)則5-4】使用英文命名標(biāo)識(shí)符。
f）重名規(guī)范
【規(guī)則6-1】不允許變量名、類名、屬性名、方法名等與系統(tǒng)標(biāo)識(shí)符重名。（系統(tǒng)標(biāo)識(shí)符見附表）
g）SQL編碼規(guī)范
【規(guī)則7-1】SQL語句全部大寫。
【規(guī)則7-2】對(duì)較為復(fù)雜的SQL語句加上注釋，說明其功能。
【規(guī)則7-3】連接符OR、IN、AND、以及=、< =、>=等前后加空格。
【規(guī)則7-4】使用明確的列代替 SELECT *。
h）軟件架構(gòu)
【規(guī)則8-1】數(shù)據(jù)庫中每一張表對(duì)應(yīng)一個(gè)實(shí)體類/數(shù)據(jù)傳輸對(duì)象（DTO）。
【規(guī)則8-2】實(shí)體類名稱使用表名，也可帶有Dto后綴。
【規(guī)則8-3】三層架構(gòu)應(yīng)當(dāng)合理使用，不應(yīng)生搬硬套。
【規(guī)則8-4】三層架構(gòu)元素推薦使用后綴：
數(shù)據(jù)傳輸對(duì)象 XxxxDto
DAO工廠 XxxDAOFactory
DAO接口 IXxxxDAO
服務(wù)接口 IxxxxService
DAO的數(shù)據(jù)庫實(shí)現(xiàn) XxxxDAOOracle/XxxxDAOInfomix
業(yè)務(wù)邏輯 XxxxManager
i）系統(tǒng)
【規(guī)則9-1】在國內(nèi)不要隨便使用設(shè)計(jì)模式等代碼模式，因?yàn)椴⒉涣餍小?/p>
【規(guī)則9-2】系統(tǒng)輸入、資源操作（如內(nèi)存分配、文件及目錄操作）、網(wǎng)絡(luò)操作（如通信、調(diào)用等）、任務(wù)間的操作（如通信、調(diào)用等）時(shí)必須進(jìn)行錯(cuò)誤、超時(shí)、或則異常處理。
【規(guī)則9-3】模塊編寫應(yīng)該有完善的測試方面的考慮。
關(guān)于C#語言規(guī)范的問題就到這里，希望對(duì)大家有用。
本文名稱：C#語言規(guī)范之小結(jié)
網(wǎng)頁路徑：http://m.5511xx.com/article/dpdsdhi.html
