
(1)每個公司,每個部門,每個團隊都喜歡搞一套編程規(guī)范,初衷很美好,然而定出來的東西從來都沒人看。道理很簡單,既然是編程規(guī)范,憑啥你定的就叫規(guī)范,依據(jù)是什么?此其一。其二,那動輒幾十頁上百頁的編程規(guī)范,到底是寫規(guī)范還是寫散文議論文說明文?
(2)當你們團隊在制定編程規(guī)范的時候是怎么做的?定個三天時間,大綱劃分好,每人分走一塊,各自開始百度谷歌,最后合并在一起,然后經(jīng)過兩三次check,期間互相撕逼和妥協(xié),最終在截止日期前如釋重負的做完這件打心底里排斥的事情。以這樣不規(guī)范的過程能定義出編程規(guī)范來?
(3)所以,關(guān)于編程規(guī)范,最好的方式是減少重復(fù)造輪子,大家來迷信一下權(quán)威,一起來遵守Google的編程規(guī)范,也就是Google Java Style。已經(jīng)有這么好的東西,為啥不拿來主義?
(4)規(guī)范,靠制度來強制是沒用的,每個coder應(yīng)自發(fā)的有這方面的意識,認認真真的看完Google的編程規(guī)范。至于如何監(jiān)管,那就做好階段性的代碼review工作。
(5)對于Android來說,編程規(guī)范主要包括兩部分,Java代碼和資源文件規(guī)范。這里列舉Google的Code style資源和Futurice公司的Android開發(fā)最佳實踐,希望大家拿來主義,減少無意義的重復(fù)工作。
- Java編程規(guī)范
- Google Java Style 中文版或者這里
- Google Java Style 官方英文版
- Android編程規(guī)范
- Android Code Style中文版
- Android Code Style官方英文版
- Android開發(fā)最佳實踐
以上兩份文檔都是針對Java代碼方面的規(guī)范,對于Android應(yīng)用來說,還有資源文件需要規(guī)范,因此,可參考Futurice公司整理的Android開發(fā)實踐,中文版和英文版的地址分別如下:中文版和英文版
在這個開源工程里,介紹了Gradle 配置、類庫推薦、資源文件命名,測試框架選擇、混淆配置等,雖然簡單,但已經(jīng)夠用,規(guī)范本來就是比較原則性的東西,細節(jié)的部分各自發(fā)揮,這樣開發(fā)者才能施展身手。
(6)如果這些編程規(guī)范還不足以涵蓋所有內(nèi)容,此時才有必要在上述規(guī)范的基礎(chǔ)上自行補充。
(7)最后祝大家都寫一手漂亮的代碼,但是不要忘記了,代碼漂亮了,把人也整理清楚點,撕掉不修邊幅的標簽,做到人如其碼,碼如其人,心中無碼。