C#代碼規范


     記錄本人在項目中所使用的規范,各種規范應該在項目啟動前就已經確立,如果后面修改起來那真他媽的煩啊,現在我在的項目就是這種情況,所以總結一下,留待后用,也和大家一起討論或分享,不一定適合所有人,不足之處請拍磚,如果您在項目中用到的規范不妨也貼出來,讓大家學習一下,謝謝!

    想到哪寫到哪,可能寫得有點亂,先寫出來以后再整理吧!也等待大拿們的規范,一起整理出一套規范文檔.

1、使用空格,不用tab

    編寫代碼時,為了易讀和美觀,盡量使用空格,不用tab,也可以把tab設置成幾個空格。因為在移動代碼保持內容格式不會發生變化

2、get訪問器放在set訪問器 之前

   通常寫法應該是Get{} Set{},在修改項目代碼時發現以前代碼的寫法 是set{} get{},很納悶,改起來也很無語。

3、類,方法,成員要添加注釋,以及參數說明

   在寫代碼時添加注釋很簡單輸入///即可自動生成,但生成之后也要把描述信息和參數說明也寫上,不要讓后人擦屁股

4、Using 聲明 和namespace之間 隔一行

    即美觀更易讀。

5、類文件頂部添加說明

    內容一般包括:

View Code
1 /* **************************************************************
2 * Copyright(c) 2005 SYSTEMS Corporation, All Rights Reserved.
3 * File : .cs
4 * Description :
5 * Author :
6 * Created :
7 * Traceability :
8 * Revision History :
******************************************************************/

6、代碼分塊處理

   代碼行數比較多時,分塊比較容易組織,也易讀,更美觀 ,個人把他分為:

View Code
 1 #region variables
2 #endregion
3
4 #region constructors
5 #endregion
6
7 #region Properties
8 #endregion
9
10 #region internal methods
11 #endregion
12
13 #region Public methods
14 #endregion
15
16 #region Private methods
17 #endregion

7、聲明變量時盡量不要用大寫的類型來聲明

  

View Code
1 string knjId = string.Empty;
2
3 String knjId = string.Empty;

8、每行代碼的長度

    每行代碼過長不易讀,眼瞅起來也非常累,所以盡量保持代碼不要過長,我們項目規定是 110
9、等號左右有空格

  好的寫法

private string knjId = string.Empty;

不好的寫法

private string knjId=string.Empty;

10、不要吝嗇{}

    我們寫if 或 for 語句時 喜歡不用{},代碼是少兩行,但不易讀,容易讓人誤解

   

View Code
 1            if (nHandler == null)
2 {
3 return this.Create(searchCriteria);
4 }
5 return null;
6 Or
7 if (nHandler == null)
8 {
9 return this.Create(searchCriteria);
10 }
11 else
12 {
13 return null;
14 }
          if (nHandler == null)
return this.Create(searchCriteria);
return null;

11、三元運算符合理運用,不要太吝嗇行數

12、。。。。等待兄弟們來貼


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM