怎么快速進(jìn)行變量和函數(shù)的命名？

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

命名原則

首先要保證一個(gè)原則，一定要和公司或者項(xiàng)目的代碼規(guī)范統(tǒng)一，其次要保證編碼命名的簡潔、望文知義。這樣做的目的就是為了協(xié)作開發(fā)和后期還能夠快速而準(zhǔn)確地理解自己的程序。

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

uint8_t ucLen；

uint8_t *pucBuf；

2、變量的命名

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

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

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

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

（4）避免使用單個(gè)字符： 除非是計(jì)數(shù)器或迭代變量，盡量避免使用單個(gè)字符的變量名，如 i 或 x，因?yàn)檫@可能會(huì)降低代碼的可讀性。

（5）避免使用數(shù)字開頭： 變量名不應(yīng)以數(shù)字開頭，因?yàn)橐詳?shù)字開頭的變量名在C語言中是無效的。

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

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

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

（9）注意命名長度： 變量名不應(yīng)過長，也不應(yīng)過短。長度適中，能夠準(zhǔn)確表達(dá)變量的含義即可。

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

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

（12）全局變量和局部變量首字母前增加G或者S進(jìn)行區(qū)分；

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

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

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

（16）命名中若使用特殊字符或者縮寫，則應(yīng)該在源文件開始處，對(duì)縮寫進(jìn)行說明。

3、enum、struct、union命名規(guī)則

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

4、函數(shù)命名規(guī)范

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

編輯：黃飛