作者：何新宇
鏈接：https://www.zhihu.com/question/21440067/answer/24522844
來源：知乎
著作權(quán)歸作者所有。商業(yè)轉(zhuǎn)載請聯(lián)系作者獲得授權(quán)，非商業(yè)轉(zhuǎn)載請注明出處。

不同的代碼段采用不同的命名長度。通常來說，循環(huán)計數(shù)器（loop counters）采用1位的單字符來命名，循環(huán)判斷變量（condition/loop variables）采用1個單詞來命名，方法采用1-2個單詞命名，類采用2-3個單詞命名，全局變量采用3-4個單詞命名。對變量采用具體的命名（specific names）方式，”value”, “equals”, “data”在任何情況下都不是一種有效的命名方式。采用有意義的命名（meaningful names）。變量的名字必須準(zhǔn)確反映它的含義和內(nèi)容。不要用 o_, obj_, m_ 等前綴命名。變量不需要前綴標(biāo)簽來表示自己是一個變量。遵循公司的變量命名規(guī)則，在項目中堅持使用同一種變量命名方式。例如txtUserName, lblUserName, cmbSchoolType等，否則會對可讀性造成影響，而且會令查找/替換工具（find/replace tools）不可用。遵循當(dāng)前語言的變量命名規(guī)則，不要不統(tǒng)一（inconsistently）地使用大/小寫字母。例如：userName, UserName, USER_NAME, m_userName, username, …。
以Java為例:
* 類名使用駝峰命名法（Camel Case）：VelocityResponseWriter
* 包名使用小寫：com.company.project.ui
* 變量使用首字母小寫的駝峰命名法（Mixed Case）：studentName
* 常量使用大寫:MAX_PARAMETER_COUNT = 100
* 枚舉類（enum class）采用駝峰命名法，枚舉值（enum values）采用大寫。
* 除了常量和枚舉值以外，不要使用下劃線’_’在同一個類不同的場景（contexts）中不要復(fù)用變量名。例如在方法、初始化方法和類中。這樣做可以提高可讀性和可維護(hù)性。不要對不同使用目的的變量使用同一個變量名，而是賦予它們不同的名字。這同樣對保持可讀性和可維護(hù)性很重要。變量名不要使用非ASCII字符（non-ASCII chars）。這樣做可能會在跨平臺使用時產(chǎn)生問題。不要使用過長的變量名（例如50個字符）。過長的變量名會導(dǎo)致代碼丑陋（ugly）和難以閱讀（hard-to-read），還可能因為字符限制在某些編譯器上存在兼容性問題。僅使用一種自然語言（natural language）來命名變量。例如，同時使用德語和英語來命名變量會導(dǎo)致（理解）不一致和降低可讀性。使用有意義的方法名。方法名必須準(zhǔn)確表達(dá)該方法的行為，在多數(shù)情況下以動詞（verb）開頭。（例如：createPasswordHash）遵循公司的方法命名規(guī)則，在項目中堅持使用同一種方法命名方式。例如 getTxtUserName(), getLblUserName(), isStudentApproved()，否則會對可讀性造成影響，而且會令查找/替換工具不可用。遵循當(dāng)前語言的變量命名規(guī)則，不要不統(tǒng)一地使用大/小寫字母。例如：getUserName, GetUserName, getusername, …。
以Java為例:
* 方法使用首字母小寫的駝峰命名法：getStudentSchoolType
* 方法參數(shù)使用首字母小寫的駝峰命名法：setSchoolName(String schoolName)使用有意義的方法參數(shù)命名，這樣做可以在沒有文檔的情況下盡量做到“自解釋（documentate itself）”

總結(jié)

以上是生活随笔為你收集整理的如何优雅地为程序中的变量和函数命名的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。