寫在前面：中國程式設計師就別寫英文注釋了！
不要寫「太牛逼」的代碼！
"傻瓜式代碼" != "低性能代碼」
=========華麗的分界線==========
程式設計師同志們大多都會有這樣的經歷，就是要看別人的代碼。比如說公司有同事離職了，他的那塊業務就需要有其它的小夥伴們給接下來繼續維護。這對好多程式設計師來說是種折磨，邊看邊罵，這寫的是什麼東西呀。相信好多人都有這種經歷。
圖片來之網際網路
那麼為啥會出現這樣一個局面哦，其實這裡面有很多講究的地方了，如果不注意的話，不光是看不懂別人寫的代碼，即使是自己寫的代碼，幾個月後你再去瞧瞧，你也會發蒙，那麼接下來就分析一下這種情況形成的原因及怎麼去解決它們。
局面形成的原因
面向過程去寫代碼
寫代碼前沒有很好的對代碼進行設計，完全是隨心所欲去實現，對自己要求比較低，就是「能實現功能就可以了」這種心態去寫代碼。這樣的代碼將是十分不好維護的，別說以後讓別人來維護這份代碼了，即使幾個月後的自己也是非常困難才能讀懂自己的代碼了。
代碼沒有注釋
代碼注釋是對讀取代碼有著非常好的輔助作用，是其他人能夠快速的了解代碼功能，同時對自己以後回頭來看自己的代碼也是十分有幫助的。沒有注釋的代碼就像深夜車燈壞了的汽車一樣，雖然能行駛，但是你敢開快麼？
代碼變量名稱隨意
比如什麼 abc,temp這類變量，這是讓誰看的呀，不根據代碼的上下文誰也不知道這是啥意思哈，如果代碼的上下文中全是類似這樣的變量，我估計看代碼的人會瘋掉了。
每個方法分工不明確
一個方法中夾雜著多種功能，讓人看了之後很難說出這個方法是幹啥的，也不敢輕易去改動。
破除這種局面
不論為自己，讓以後自己能看懂自己的代碼，還是為別人能看懂自己的代碼，讓自己不挨罵，那麼就推薦以下幾種方法來規範自己的代碼，讓別人或者是自己能夠輕輕鬆鬆看懂自己的代碼
實現功能前先設計好代碼
最好是面向對象的方式編程，不論是java還是php都能很好的應用面向對象的方式進行編程，設計好文件名，類名，以及方法名，不論是文件名，還是類名，方法名都要做到見名知意，要用標準的英文去表示，需要用多個英文表示就用駝峰標識來表達。讓人看上去結構一目了然，代碼看上去讓人賞心悅目。
注釋寫的儘量詳細
每個類，每個方法都要寫明注釋， 類的注釋可以簡明寫這個類的主要功能，但是每個方法的注釋儘量要寫細了，注釋一定要覆蓋方法中所實現的所有功能，而不是只寫其中一部分。看過系統級源碼的程式設計師都知道，注釋的行數是比代碼的行數還要多的。這就是優秀的習慣，我們也要去學習。
不要隨便定義臨時變量
儘量不要定義一些臨時變量，如果十分必要定義時，最好時加上單行注釋，讓其他人知道你的意圖。
不要寫過長的方法
每個方法最好不要超過500行代碼，如果過長了，可以考慮該方法的功能點是否可以再次拆分，最好是一個方法就實現單一一個功能，這樣的話方法的復用率也會提高的。
不要寫太「牛逼」的代碼了
有的程式設計師喜歡寫非常個性的代碼，喜歡寫一些別人很難看懂的代碼，他認為這樣才能顯示出自己的「高水平」，這樣就不是高水平了，只能說代碼的可讀性太差了，我們要寫出傻瓜式代碼，也就是說讓很傻的程式設計師都能看懂，"傻瓜式代碼" != "低性能代碼」哈，這一點要分開。
中國人就別寫英文注釋了
好多國內的程式設計師給代碼寫注釋用英文寫，如果英文非常好的話寫英文注釋那當然是無可厚非，如果你英文不好，就是為了裝13的話，那麼還是勸你別寫英文注釋了，你這不是在折磨自己也折磨別人嘛。讓我記得最荒唐的一個程式設計師的做法是，他為代碼寫了漢語注釋，然後用百度翻譯把它翻譯成英語貼到自己的代碼裡，呵呵，這哥們也夠逗的了。
大家好，我是「上世是朵花」。如果你有什麼好的看法或者觀點可以在評論區展現你的才華，互動交流，如果想進一步了解我，那就關注我吧。