如何提高代碼的可維護性
提高代碼的可維護性的出路就是:
注意代碼規範!
注意代碼規範!
注意代碼規範!
要統一語言
為啥一直在強調代碼規範呢?好比大家都是說中國話,一個團隊如果十個人有九個是說普通話的,但其中有一個是說的「川普」,雖然,講「川普」的人,聽其他九個人表達都沒有問題,但如果要讓其他九個人都能順利聽懂「川普」,那就有點困難。而且容易生出歧義。
so,團隊裡面,要講統一的語言。這種語言,可以是普通話,也可以是「川普」,但必須要統一。統一語言有利於減少溝通的障礙。
統一的代碼規範,有利於大家互相看對方的代碼。畢竟,你寫的代碼不一定或者不可能永遠只有你來做維護。讓大家都能看懂你的代碼,是做好維護的最重要的前提。
最好說普通話
前面講了,普通話或者是「川普」都可以作為團隊裡面的統一語言。但如果,你團隊的人離開的團隊去到了外部的其他團隊或者公司,那麼是否要重新學習另外一門團隊語言呢?答案是:是的。因為每個團隊都需要統一的語言。新加入的組員必須要馬上學會該團隊的語言。
唯一可以可以降低學習語言的成本,就是講普通話。畢竟,「川普」還是小宗語言,大部分團隊可能都是講普通話,所以「學好普通話,走遍天下都不怕」。
在編碼過程中,編碼規範是及其重要的。每個團隊幾乎都又自己的編碼規範,但仍然可以做到大部分團隊都通用的編碼規範。比如,《Java 編碼規範》(https://github.com/waylau/java-code-conventions),來自Java 締造者SUN公司的規範,就可以作為大多數人的規範。
在中國,互聯網企業裡面大公司的規範也可以作為自己團隊的規範的參考,比如阿里巴巴Java規範等。
規範從早養成
簡言之,規範要從每一行代碼都要開始遵守,不管是個人項目,還是團隊項目,規範就是紀律,就是高壓線,時刻提醒自己要牢記。
只有從點滴積累,才能養成習慣。而只有好習慣,才是成功的關鍵!
總結
提高代碼的可維護性從遵守代碼規範做起!


TAG:極客教程 |