年前整理的C#規範

一劍平江湖發表於2014-02-10

年前,領導讓整理下簡單的程式設計規範,不用太細緻,主要是統一開發人員的編碼風格。一共3份,分別為C#,Js,CSS。其中有自己的心得,也有部分從網上搜來的。

C#編碼規範
一,基本約定
1. 所有的命名名稱都必須使用能直接體現具體含義的名字。不能使用x,y,z等無意義的名稱進行定義,迴圈變數除外。
2. 所有的成員變數必須在所有成員方法前面宣告,用一個換行把它和方法分開
3. switch語句一定要有default來處理意外情況。
4. 同程式外部連線(如連線資料庫、介面、檔案等)一定要捕獲任何型別的異常(try)給出友好的訊息給使用者,必要時用日誌記錄錯誤的細節,包括髮生的時間,和相關方法,類名等。
5. 不在程式碼中使用具體的路徑和驅動器名,必須使用相對路徑。
6. 程式碼的縮排用Tab,而不要用space。
7. 一個方法只完成一個任務。不要把多個任務組合到一個方法中。
8. 避免使用大檔案。如果一個檔案裡的程式碼超過300~400行,可考慮將程式碼分開到不同類中。
9. 重要變數必須有註釋。  
10. 注意todo的運用 
二,命名規範
1. 常量 全部大寫,單詞之間以 “_” 分隔,例:USER_PASSWORD。
2. 類  採用Pascal命名規則
3. 方法 採用Pascal命名規則,一般將其命名為動賓短語
4. 成員變數 與類命名規則相同,私有變數首字母小寫或加小寫字首。
5. 其它可遵循ReSharper的編碼規範
三,註釋規範
1、 註釋必須使用中文及中文的標點符號, 每行註釋的最大長度不能超過1024*800或者常用的螢幕的寬度 
2、 檔案必須有註釋
3、 典型演算法必須有註釋。  
4、 在迴圈和邏輯分支的地方必須寫上註釋。  
5、 程式段或語句的註釋在程式段或語句的上一行。

相關文章