年前整理的C#规范
年前,領(lǐng)導(dǎo)讓整理下簡(jiǎn)單的編程規(guī)范,不用太細(xì)致,主要是統(tǒng)一開(kāi)發(fā)人員的編碼風(fēng)格。一共3份,分別為C#,Js,CSS。其中有自己的心得,也有部分從網(wǎng)上搜來(lái)的。
C#編碼規(guī)范
一,基本約定
1. 所有的命名名稱都必須使用能直接體現(xiàn)具體含義的名字。不能使用x,y,z等無(wú)意義的名稱進(jìn)行定義,循環(huán)變量除外。
2. 所有的成員變量必須在所有成員方法前面聲明,用一個(gè)換行把它和方法分開(kāi)
3. switch語(yǔ)句一定要有default來(lái)處理意外情況。
4. 同程序外部連接(如連接數(shù)據(jù)庫(kù)、接口、文件等)一定要捕獲任何類型的異常(try)給出友好的消息給用戶,必要時(shí)用日志記錄錯(cuò)誤的細(xì)節(jié),包括發(fā)生的時(shí)間,和相關(guān)方法,類名等。
5. 不在代碼中使用具體的路徑和驅(qū)動(dòng)器名,必須使用相對(duì)路徑。
6. 代碼的縮進(jìn)用Tab,而不要用space。
7. 一個(gè)方法只完成一個(gè)任務(wù)。不要把多個(gè)任務(wù)組合到一個(gè)方法中。
8. 避免使用大文件。如果一個(gè)文件里的代碼超過(guò)300~400行,可考慮將代碼分開(kāi)到不同類中。
9. 重要變量必須有注釋。 ?
10. 注意todo的運(yùn)用?
二,命名規(guī)范
1. 常量 全部大寫(xiě),單詞之間以 “_” 分隔,例:USER_PASSWORD。
2. 類 ?采用Pascal命名規(guī)則
3. 方法 采用Pascal命名規(guī)則,一般將其命名為動(dòng)賓短語(yǔ)
4. 成員變量 與類命名規(guī)則相同,私有變量首字母小寫(xiě)或加小寫(xiě)前綴。
5. 其它可遵循ReSharper的編碼規(guī)范
三,注釋規(guī)范
1、 注釋必須使用中文及中文的標(biāo)點(diǎn)符號(hào), 每行注釋的最大長(zhǎng)度不能超過(guò)1024*800或者常用的屏幕的寬度?
2、 文件必須有注釋
3、 典型算法必須有注釋。 ?
4、 在循環(huán)和邏輯分支的地方必須寫(xiě)上注釋。 ?
5、 程序段或語(yǔ)句的注釋在程序段或語(yǔ)句的上一行。
總結(jié)
- 上一篇: 飞鸽传书2011绿色版使用简介
- 下一篇: 【飞秋】C# 调用