如何給C#變量取名字

Posted on by

一.變量命名風格

變量命名風格通常會根據不同的變量類型來區分，以Java語言為例，根據變量類型不同有兩種命名風格：

1）類成員變量、局部變量

類成員變量、局部變量通常采用駝峰命名風格，如下：

String userName;

2）靜態成員變量、枚舉值、常量

靜態成員變量、枚舉值、常量通常采用所有字母大寫、多個單詞以英文下劃線連接，如：

public static final int MAX_YEARS = 25;
// 建議枚舉類都以Enum結尾
enum ColorEnum {
    RED(0, "紅色"),
    YELLOW(1, "黃色"),
    GREEN(2, "綠色"),
    WHITE(3, "白色"),
    BLACK(4, "黑色");
    private int code;
    private String name;
    Color(int code, String name) {
        this.code = code;
        this.name = name;
    }
}

二.變量命名最高境界

在函數命名那篇中我們說的函數命名最高境界是見字如面，那麼對於變量命名來說，最高境界是什麼呢？我認為是：自解釋，即"代碼即註釋"。

為什麼這麼說呢，因為通常來說一個函數是會有函數註釋的，即使函數名字取的不好，如果註釋寫的比較清楚，對於後續維護人員來說也是瞭解函數具體功能的一種方式。

而變量則不同，在一個工程裡面，變量的數量遠遠大於函數的數量，所以不太可能對於每個變量都去寫註釋，所以如果一個工程的變量命名很糟糕，那麼對於後續維護人員來說將是毀滅性的打擊，因為每讀到一個變量，可能就需要去猜測變量的含義，我想沒有哪個人願意讀到這樣的代碼，永遠記住一點：“代碼是寫給人看的，不是寫給機器看的”。

譬如下面這段代碼的命名就非常糟糕：

ppn = (cpn > 1) ? (cpn - 1) : cpn;
npn = (cpn < tpn) ? (cpn + 1) : tpn;
p = new Page(ppn, cpn, npn, tpn);

上面這段代碼估計隻有原作者清楚地知道各個變量的含義是啥瞭，

如果修改為下面這種寫法，可讀性會好很多，並且一目瞭然，很容易知道其大概意圖是計算分頁信息：

prePageNum = (curPageNum > 1) ? (curPageNum - 1) : curPageNum;
nextPageNum = (curPageNum < totalPageNum) ? (curPageNum + 1) : totalPageNum;
page = new Page(prePageNum, curPageNum, nextPageNum, totalPageNum);

三.變量命名最佳實踐

1）采用名詞或者形容詞來命名變量

變量一般情況下建議使用名詞、名字組合或者形容詞，因為變量一般形容的是一種事物或者事物的屬性，所以用名詞或者名詞組合更容易讓人理解，而形容詞一般用於bool類型的變量。

2）避免使用單字母變量，盡量細化變量含義

在程序中，盡量避免使用單字母變量，唯一可以接受使用單字母變量的場景隻有for循環，不過還是不太推薦在for循環中使用單字母變量(用pos、index比for循環的i、j、k要好很多)。

舉個例子，比如下面這行代碼：

double calConeVolume(double b, double d) {
  return Math.PI * b * b * d / 3;
}

咋一看這個函數參數感覺挺清晰，但是一細看，b是什麼？d又是什麼？如果我要用這個函數，該怎麼傳參？估計大部人是一臉懵逼狀，隻能進去看實際的函數實現才知道b是圓錐體半徑，d是圓錐體高度；

那麼怎麼優化這段代碼命名呢？其實很簡單，稍微細化一下變量含義，讓變量名自己去表達實際意圖：

double calConeVolume(double radius, double height) {
  return Math.PI * radius * radius * height / 3;
}

3）變量命名前後用詞需統一

在同一個工程或者一個場景下，變量命名風格需前後統一，比如total和sum都能表示總計的意思，那麼所有需要用到"總計"含義的地方要麼全部使用total、要麼全部使用sum。

保持前後命名風格統一是保證工程代碼良好可讀性的關鍵保證。

4）集合變量用類型或者復數s作為後綴

在java中，有很多集合，比如List、Map、Set等，那麼集合變量該怎麼命名呢？

一般可采取兩種方式：

使用復數s結尾

List students = new ArrayList<>();

用集合類型作為後綴

List studentList = new ArrayList<>();

上面兩種方式均可，沒有比較明顯的偏好，根據實際場景決定。第一種方式相對更簡潔，第二種在局部作用域裡面有多種相關的集合變量時區分度更大，比如：

List<Student> studentList = new ArrayList<>();
Map<Long, Student> studentMap = Maps.newHashMap();
for (Student stu : studentList) {
  studentMap.put(stu.getId, stu);
}

我的建議是如果局部作用域隻有一種類型的集合，那麼推薦使用復數形式；如果局部作用域有多個相關的集合類型，那麼推薦用類型結尾。

5）禁止使用is作為bool類型的類成員變量前置

在java中，禁止用is作為bool類型的類成員變量的前綴，因為is作為前綴會導致序列化/反序列出現問題，阿裡的java代碼規范中也明確提到瞭這一點，所以在寫代碼的時候最好還是遵守公認的規范，不然哪天說不定就踩坑瞭。

6）盡量避免使用縮寫進行命名

有些時候，變量名可能有點長，不利於代碼可讀性，因此很多時候在寫代碼的時候喜歡用縮寫來命名，但這個不是一個好的習慣，除非使用的縮寫是大傢都會使用的約定俗稱的縮寫。

比如下面這個命名：

int averageStudentAge; => int avgStudentAge;

因為avg大傢都知道是average的縮寫，所以這麼寫問題不大，不會引起歧義；
但是下面這種縮寫命名：

res
tmp
cnt

就不是好的縮寫命名，因為不同的人閱讀可能會有不同的理解：

res => response、resource、result
tmp => temporary、template
cnt => count、content、context

附上一些約定俗稱的縮寫：

全稱 縮寫
identification id
average avg
maximum max
minimum min
buffer buf
error err
message msg
image img
length len
library lib
password pwd
position pos
data transfer object dto
view object vo

7）拋棄掉flag變量

國內一些早期的教材上，到處充斥著各種flag風格的變量，這種命名方式對於大型工程簡直就是噩夢，比如：

int flag = getDoctorFlag(doctorId);
if (flag == 1) {
  //....
}

看到這段代碼，讀者會有疑問flag變量的含義是什麼？flag值為1的時候又代表什麼含義？是醫生的值班/在崗狀態、還是醫生的身體狀態？估計讀者的內心是崩潰的。
如果優化成下面這種形式：

DutyStatus doctorDutyStatus = getDoctorDutyStatus(doctorId);
if (doctorDutyStatus == DutyStatus.ONLINE) {
  // ...
}

就比上面的形式清晰多瞭，很容易看出來判斷的是醫生的值班/在崗狀態。

到此這篇關於如何給C#變量取名字的文章就介紹到這瞭,更多相關C#變量取名字內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：