在任何語言開發(fā)中,都有其語言領(lǐng)域的一些命名規(guī)范,好的命名可以:
- 降低代碼閱讀成本
- 降低維護(hù)難度
- 降低代碼復(fù)雜度
規(guī)范建議
在我們實(shí)際開發(fā)中,有很多開發(fā)人可能是由某一語言轉(zhuǎn)到另外一個語言領(lǐng)域,在轉(zhuǎn)到另外一門語言后, 我們都會保留著對舊語言的編程習(xí)慣,在這里,我建議的是,雖然不同語言之前的某些規(guī)范可能是相通的, 但是我們最好能夠按照官方的一些demo來熟悉是漸漸適應(yīng)當(dāng)前語言的編程規(guī)范,而不是直接將原來語言的編程規(guī)范也隨之遷移過來。
命名準(zhǔn)則
- 當(dāng)變量名稱在定義和最后一次使用之間的距離很短時,簡短的名稱看起來會更好。
- 變量命名應(yīng)盡量描述其內(nèi)容,而不是類型
- 常量命名應(yīng)盡量描述其值,而不是如何使用這個值
- 在遇到for,if等循環(huán)或分支時,推薦單個字母命名來標(biāo)識參數(shù)和返回值
- method、interface、type、package推薦使用單詞命名
- package名稱也是命名的一部分,請盡量將其利用起來
- 使用一致的命名風(fēng)格
文件命名規(guī)范
- 全部小寫
- 除unit test外避免下劃線(_)
- 文件名稱不宜過長
變量命名規(guī)范參考
- 首字母小寫
- 駝峰命名
- 見名知義,避免拼音替代英文
- 不建議包含下劃線(_)
- 不建議包含數(shù)字
適用范圍
- 局部變量
- 函數(shù)出參、入?yún)?/li>
函數(shù)、常量命名規(guī)范
- 駝峰式命名
- 可exported的必須首字母大寫
- 不可exported的必須首字母小寫
- 避免全部大寫與下劃線(_)組合
更多建議: