C#編碼好習慣小結

2024-09-07 17:05:18

字體：大中小

來源：轉載

供稿：網友

1.  避免將多個類放在一個文件里面。
2.  一個文件應該只有一個命名空間，避免將多個命名空間放在同一個文件里面。

3.  一個文件最好不要超過500行的代碼（不包括機器產生的代碼）。

4.  一個方法的代碼長度最好不要超過25行。

5.  避免方法中有超過5個參數的情況。使用結構來傳遞多個參數。

6.  每行代碼不要超過80個字符。

7.  不要手工的修改機器產生的代碼。

a)  如果需要編輯機器產生的代碼，編輯格式和風格要符合該編碼標準。

b)  Use partial classes whenever possible to factor out the maintained portions.

8.  避免利用注釋解釋顯而易見的代碼。

a)  代碼應該可以自解釋。好的代碼由可讀的變量和方法命名因此不需要注釋。

9.  Document only operational assumptions, algorithm insights and so on.

10.  避免使用方法級的文檔。

a)  使用擴展的API文檔說明之。

b)  只有在該方法需要被其他的開發者使用的時候才使用方法級的注釋。（在C#中就是///）

11.  不要硬編碼數字的值，總是使用構造函數設定其值。

12.  只有是自然結構才能直接使用const，比如一個星期的天數。

13.  避免在只讀的變量上使用const。如果想實現只讀，可以直接使用readonly。

public class MyClass

{

   public readonly int Number;

   public MyClass(int  someValue)

   {

      Number = someValue;

   }

   public  const int  DaysInWeek = 7;

}

14.  每個假設必須使用Assert檢查

a)  平均每15行要有一次檢查(Assert)

using System.Diagnostics;

object GetObject()

{…}

object obj = GetObject();

Debug.Assert(obj != null);

15.  代碼的每一行都應該通過白盒方式的測試。

16.  只拋出已經顯示處理的異常。

17.  在捕獲(catch)語句的拋出異常子句中(throw)，總是拋出原始異常維護原始錯誤的堆棧分配。

catch(Exception exception)

{

   MessageBox.Show(exception.Message);

   throw ;  //和throw exception一樣。

}

18.  避免方法的返回值是錯誤代碼。

上一篇：C#中的委托和事件學習(續)

下一篇：C#語言初級入門介紹