2017年10月12日 星期四

程式變數命名原則

撰寫程式時,良好的註解習慣是不可或缺的。

而程式的變數名稱可以視為此變數最直觀的註解,因此如何替變數取一個好名字就是撰寫程式時的藝術了。

一般在替程式命名時,會有幾種規則,這些命名法則並無特殊優劣,但我們會希望在整個程式碼中變數的命名方式(風格)是一致的。

  • 駝峰式(Camel Case)一般又可分為大駝峰與小駝峰:
    • 大駝峰,也被稱作Pascal case,變數的首字母為大寫,並且各表意的單字字首皆以大寫區分,如LocalQvaporAccumulate。
    • 小駝峰,各表意的單字字首同樣以大寫區分,惟變數首字母為小寫,如localQvaporAccumulate。

  • Snake Case
    各表意單字間以下劃線「_」區分,如local_qvapor_accumulate。

  • Kebab Case
    各表意單字間以連接符號「-」區分,如local-qvapor-accumulate。

  • 匈牙利命名法(Hungarian notation)
        這種命名法的特性在於會將變數的資料型態放在字首,如"lAccountNum",其中的 "l"就表示此變數屬於長整數型態;或透過字首表示變數目的的提示或是變數代表了甚麼,如"strName"中的str就表示此變數屬於字串。


個人習慣使用Pascal Case來替變數命名,但若在較為複雜的迴圈中,則採用SnakeCase輔助辨識迴圈index所代表的意義,如i_x、j_y、k_lev等。

沒有留言:

張貼留言