命名規範和命名習慣
C#中一些常用的命名習慣:Pascal 大小寫形式:所有單詞第一個字母大寫,其他的字母小寫。
Camel 大小寫形式:除了第一個單詞大寫,其他的字母小寫。
1. 類名使用Pascal 大小寫形式
public class HelloWorld{ ...}
2. 方法使用Pascal 大小寫形式
public class HelloWorld{ void SayHello(string name) { ... }}
3. 變數和方法參數使用Camel 大小寫形式
public class HelloWorld{ int totalCount = 0; void SayHello(string name) { string fullMessage = "Hello " + name; ... }}
4. 不要使用匈牙利方法來命名變數
以前,多數程式員喜歡它-把資料類型作為變數名的首碼而m_作為成員變數的首碼。例如:
string m_sName;int nAge;
然而,這種方式在.NET編碼規範中是不推薦的。所有變數都用camel 大小寫形式,而不是用資料類型和m_來作首碼。
5. 用有意義的,描述性的詞語來命名變數
- 別用縮寫。用name, address, salary等代替 nam, addr, sal
- 別使用單個字母的變數象i, n, x 等. 使用 index, temp等
用於迴圈迭代的變數例外:
for ( int i = 0; i < count; i++ ){ ...}
如果變數只用於迭代計數,沒有在迴圈的其他地方出現,許多人還是喜歡用單個字母的變數(i) ,而不是另外取名。
- 變數名中不使用底線 (_) 。
- 命名空間需按照標準的模式命名
6. 檔案名稱要和類名匹配
例如,對於類HelloWorld, 相應的檔案名稱應為 helloworld.cs (或, helloworld.vb)
7. 縮排和間隔
縮排用 TAB . 不用 SPACES.。
注釋需和代碼對齊.。
花括弧 ( {} ) 需和括弧外的代碼對齊.。
用一個空行來分開代碼的邏輯分組。.
在一個類中,各個方法需用一空行,也只能是一行分開。
花括弧需獨立一行,而不象if, for 等可以跟括弧在同一行。.
在每個運算子和括弧的前後都空一格。.
好:
if ( showResult == true ) { for ( int i = 0; i < 10; i++ ) { // } }
不好:
if(showResult==true) { for(int i= 0;i<10;i++) { // } }