怎么快速進行變量和函數的命名？

前段時間共享了常用單詞的縮寫【總結了近800個工程師寫程序常用的英語單詞以及縮寫；例如：configuration-》cfg】，但仍有不少分析從后臺反應，看了英文縮寫仍然寫不出看著更專業的軟件。下面小編再共享一下常用的軟件編碼的規范和技巧：編程中其實比較頭痛的一件事就是定義變量到詞窮，編寫出看似很專業的軟件其實最重要的是變量命名的方法套路，接下來就教教你怎么快速進行變量和函數的命名。

命名原則

首先要保證一個原則，一定要和公司或者項目的代碼規范統一，其次要保證編碼命名的簡潔、望文知義。這樣做的目的就是為了協作開發和后期還能夠快速而準確地理解自己的程序。

1、使用合適的匈牙利命名規則開頭加上某種前綴來標識這個變量的類型，或者方法的功能，基本原則就是：變量名=屬性+類型+對象描述。例如：

uint8_t ucLen；

uint8_t *pucBuf；

2、變量的命名

變量可以使用縮寫，但需要加注釋。盡量不要用縮寫，如果一定要縮寫，一定要堅持統一的縮寫原則，下面提供一些方法變量命名的常用方法和注意事項：

（1）有意義的名稱： 變量名稱應該反映出變量的含義，使人們能夠迅速理解變量的作用。

（2）駝峰命名法（CamelCase）： 首字母小寫，后續單詞首字母大寫，如 myVariableName。

（3）下劃線命名法（Snake Case）： 所有字母小寫，用下劃線分隔單詞，如 my_variable_name。

（4）避免使用單個字符： 除非是計數器或迭代變量，盡量避免使用單個字符的變量名，如 i 或 x，因為這可能會降低代碼的可讀性。

（5）避免使用數字開頭： 變量名不應以數字開頭，因為以數字開頭的變量名在C語言中是無效的。

（6）使用有意義的單詞： 選擇能夠準確描述變量用途的單詞，避免使用模糊或難以理解的縮寫。

（7）遵循項目的命名約定： 如果項目中已經有一套命名規范，要遵循該規范以保持一致性。

（8）避免使用保留字： 不要使用C語言的保留字作為變量名，以免引發編譯錯誤。

（9）注意命名長度： 變量名不應過長，也不應過短。長度適中，能夠準確表達變量的含義即可。

（10）使用名詞和動詞： 變量名可以使用名詞表示對象，也可以使用動詞表示操作，以更好地反映變量的用途。

（11）避免過度縮寫： 盡量避免過度縮寫，以免造成歧義。但如果某個縮寫在項目中廣泛使用且被廣泛理解，那么可以考慮使用。較短的單詞可以通過去掉“元音”形成縮寫；

（12）全局變量和局部變量首字母前增加G或者S進行區分；

（13）較長的單詞可以取單詞前幾個字母形成縮寫，一般取前三個字母；

（14）如果存在多個單詞較長情況，一般取每個單詞的首字母組成變量；

（15）多使用約定成俗的英文單詞縮寫

（16）命名中若使用特殊字符或者縮寫，則應該在源文件開始處，對縮寫進行說明。

3、enum、struct、union命名規則

enum（枚舉）類型，前綴使用“e”+枚舉變量名，其成員前綴為枚舉變量或者其縮寫；struct（結構體）類型，前綴使用“s”+結構體變量名，其成員和變量定義規則相同；union（聯合）類型，前綴使用“u”+聯合體變量名，其成員和變量定義規則相同；

4、函數命名規范

使用描述函數執行動作的動詞，后跟能夠清楚表達函數目的的名詞。例如：calculateSum（）、printMessage（）。一般嵌入式編程需要加前綴，這個前綴一般是所在模塊名字。

編輯：黃飛