程式碼要規範
我認識一個哥哥,他是典型的程式設計師,我看過他寫的程式洋洋灑灑的n多行,基本每一段都有詳細的註釋一整弄得跟答案詳解。他跟我說: “看到幾百甚至上千行程式碼,哪怕是自己寫的也會缺少註釋而猜測以及花很多時間去理清楚前後邏輯。因為就連自己也根本記不住。”所以我認為遵循一些簡單的規範,寫乾淨一致的程式碼是很重要的!
把自己的個性用在寫出最簡單易懂的程式碼上面,而不是晦澀冗餘無用的程式碼,甚至自我簽名!自己的才華應該表現在設計良好的結構和模式,表現在乾淨易懂的程式碼,表現在對空間的尊重,對程式碼的尊重。這樣您才能贏得別人的尊重!程式碼不是一次性的,需要重複的修改和重構,所以我們很多時候是在為未來寫點程式碼。
以下我對別人給我的建議和自己的一點小經驗做出的總結:
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 命名類,方法,變數慎用簡寫,除非大家都公認。全稱我都不一定看得懂,簡稱您太高估我的智商了!
1.8 把所有的類變數放到最前面,如果比較多請按用途分組排列,不要把變數散落在大江南北,我找的真的很辛苦!
1.9 拆分大的類,大的方法,如果您的類有一萬行,如果您的方法有一千行,我真的會恐懼,是恐懼!
2. 高效運用註釋
2.1 規範的註釋類資訊。請檢視一下Java標準庫的String.java原始碼吧,包括檔名,日期,作者,版本號等資訊,用統一的模板。千 萬別把您的大名散落於方法簽名甚至於具體程式碼裡面了。我在讀業務邏輯的時候沒有興趣思考您的人生!要找您我可以在類簽名裡面找到的,放心啊!
2.2 非Java Bean的public方法都需要註釋,您總不會要別人讀您的程式碼才能呼叫您的程式碼吧!即便您的英文非常好,命名也非常規範,您總不能期待別人都英文好,理解都一樣吧。
2.3 為不容易理解類變數註釋。類變數特別是私有的類變數沒有人要求註釋,但是為了能夠快速的瞭解您表示的是什麼,還是寫點什麼吧!您知道我英文不算好!
2.4 註釋程式碼段,註釋邏輯選擇。上面提到運用空行分割開邏輯相對獨立的程式碼,那麼請在空行的下一行也寫點下面程式碼段要幹什麼的語句吧。 如果有if else等邏輯選擇的時候,麻煩也花幾秒鐘寫上判斷的依據和結果好嗎?邏輯難懂且關鍵,您懂的!
3. 不斷學習,不斷思考,不斷實踐,更上一層樓
3.1 看別人程式碼時要汲取好的方法和技巧。
3.3 接觸一項技術要升入瞭解和實踐,請問您做過的系統您現在都可以從零開始搭建起來了嗎,我的意思是架構搭建哦!
3.4 書裡面有知識,有思想,有時間的話可以多精讀幾本經典書籍。
以上只是一點個人的想法,您可以接受或者反駁。