代碼規範的那些事兒

做爲一個苦逼的程序員，由於種種緣由常常須要閱讀別人寫的代碼。您是否有因代碼雜亂冗餘而心生厭惡，您是否有過因代碼晦澀難懂而抓狂，您是因代碼低級的邏輯錯誤而憤概，您是否因代碼結構不合常規而須要處處查找，您是否因看到幾百甚至上千行代碼的方法而望洋興嘆，您是否因代碼缺乏註釋而猜想以及花不少時間去理清楚先後邏輯。苦逼的我所有遇到過而且不少不少，這些代碼的做者從世界500強頂級IT公司到幾十人的小公司同事，從印度美國新加坡人到中國人，從七八年的老人到剛入行的菜鳥。相信您也遇到過。這些人有一些共性，應付任務，個性十足以及不思進取！若是您是程序員菜鳥，那麼您必定遇到不少而且既是肇事者又是受害者，這是必經之路；若是你是業界大牛，不用說您眼裏別人的代碼都或多或少都有問題，遇到的狀況更多！

都說代碼是程序員的第二張臉，寫了太爛的代碼背後必定會遭人鄙視。請遵循一些簡單的規範，寫乾淨一致的代碼！請把您的個性用在寫出最簡單易懂的代碼上面，而不是晦澀冗餘無用的代碼，甚至自我簽名！您的才華應該表如今設計良好的結構和模式，表如今乾淨易懂的代碼，表如今對空間的尊重，對代碼的尊重。這樣您才能贏得別人的尊重！請記住代碼不是一次性的，須要重複的修改和重構，爲將來寫點代碼！如下我總結幾點Java裏面最基本的小規範：

1.  寫乾淨整潔的代碼，請尊重空間，請尊重人眼的偏好

1.1  去除沒有用到的類引用，eclipse裏面Ctrl+Shilft+O。看到一大片的由於類引用沒有用到而報的警告信息簡直就是災難，空間和視覺都沒有獲得尊重。

1.2  記得格式化代碼，eclipse裏面Ctrl+Shilft+F。看到一大片雜論無章，連基本的對齊都沒有的代碼也是很大的災難，視覺腦力都會受到挑戰。

1.3  不要吝惜廢棄的老代碼，eclipse裏面Ctrl+D。有些人對待已經廢棄的老代碼比對待本身的老婆還寶貝，大量運用註釋來保留，隨 着代碼的演變暫用很是大量的空間。若是那段代碼很是精妙，捨不得刪，那麼請把它移到您的私人代碼庫。

1.4  請不要寫冗餘無用的代碼。if(true)之類的代碼塊徹底不該該出現，用空行隔開該段代碼是更好的選擇。

1.5  請合理運用空行。空行能夠用來隔開相對獨立的代碼塊，有利於閱讀和理解。可是不要使用超過一行的空行，對空間，別太奢侈了。

1.6  請不要在兩個地方出現徹底相同的代碼，您老是能夠想辦法重用的，不是嗎？

1.7 命名類，方法，變量慎用簡寫，除非你們都公認。全稱我都不必定看得懂，簡稱您過高估個人智商了！請問qrbs表明什麼，可能火星人知道吧！

1.8 把全部的類變量放到最前面，若是比較多請按用途分組排列，不要把變量散落在大江南北，我找的真的很辛苦！

1.9  拆分大的類，大的方法，若是您的類有一萬行，若是您的方法有一千行，我真的會恐懼，是恐懼！

2.  高效運用註釋

2.1  規範的註釋類信息。請查看一下Java標準庫的String.java源碼吧，包括文件名，日期，做者，版本號等信息，用統一的模板。千 萬別把您的大名散落於方法簽名甚至於具體代碼裏面了。我在讀業務邏輯的時候沒有興趣思考您的人生！要找您我能夠在類簽名裏面找到的，放心啊！

2.2  非Java Bean的public方法都須要註釋，您總不會要別人讀您的代碼才能調用您的代碼吧！即使您的英文很是好，命名也很是規範，您總不能期待別人都英文好，理解都同樣吧。

2.3  爲不容易理解類變量註釋。類變量特別是私有的類變量沒有人要求註釋，可是爲了可以快速的瞭解您表示的是什麼，仍是寫點什麼吧！您知道我英文不算好！

2.4  註釋代碼段，註釋邏輯選擇。上面提到運用空行分割開邏輯相對獨立的代碼，那麼請在空行的下一行也寫點下面代碼段要幹什麼的語句吧。 若是有if else等邏輯選擇的時候，麻煩也花幾秒鐘寫上判斷的依據和結果好嗎？邏輯難懂且關鍵，您懂的！

3. 不斷學習，不斷思考，不斷實踐，更上一層樓

3.1 遇到不懂的，請先google，必定要學會，否則就一直不會了，回頭發現工做六七年沒有工做兩年的小朋友懂的多！

3.2 看別人代碼時要汲取好的方法和技巧。

3.3 接觸一項技術要升入瞭解和實踐，請問您作過的系統您如今均可以從零開始搭建起來了嗎，個人意思是架構搭建哦！

3.4 書裏面有知識，有思想，有時間的話仍是多精讀幾本經典書籍吧。您會受益不淺！

以上只是一點我的的想法，您能夠接受或者反駁。謝謝您的時間，就這樣！