隨著《阿里巴巴Java開發(fā)手冊》的公開,重新又掀起一股編碼規(guī)范的風口。結(jié)合《華為java編程規(guī)范》以及團隊內(nèi)部的實踐,我們也做了一段開發(fā)規(guī)范。不求最全,但求有效。
里面的規(guī)范,暫時只分兩類?!皬娭啤?,即如果違反就不能使用級別。比如說,在codereview有遇到 ,那就會直接把pull request打回去,拒絕合并到開發(fā)者穩(wěn)定分支上?!巴扑]”,即建議怎么做,但是不強制,根據(jù)不同的水平可以做一些參考。
通用規(guī)范
所有的情況下都通用
1、 【強制】命名全部使用英文,禁止中文或者中英混合。項目名除外,因為有的項目是按域名來命名的,域名本身有可能是中文拼音。
例子:
域名:kecheng.xxx.com項目名:xxx-web-kecheng
2、 【強制】禁止使用縮寫,除非提供一個縮寫列表
反例:
# 這里的t到底是什么意思?topic_id?還是teacher_id?字段:t_id
3、 【強制】禁止出現(xiàn)除了后綴或者前綴3個單詞。如果超過3個,說明想表達的職責太多,可以拆分或者封裝。
編程語言
這里主要指的是Java語言,其他的語言也可以借鑒這些準則
類
1、 【強制】需要有統(tǒng)一的后綴或者前綴。為了一看類名,就知道這個類干什么的。
前綴列表:
抽象類(Abstract)
接口(I)