做爲一名程序猿最討厭作的事是什麼?程序員
產品經理頻繁修改需求?不是。面試
測試每天給你提交不可理喻的 bug ?也不是。微信
接手別人交接的如火星文同樣的爛代碼?還不是。架構
▼函數
程序員最討厭的四件事:工具
寫註釋、寫文檔、別人不寫註釋、別人不寫文檔。學習
不錯,今天咱們就來談談程序員最討厭作的這件事:測試
寫註釋!編碼
其實對於寫註釋這件事來講,仍是有必定的爭議的,爭議其實不在於該不應寫註釋,而是在於不要過多的寫註釋,註釋多了,反而會讓你感受整個代碼比較混亂不堪,影響視覺。翻譯
並且爲何不太鼓勵你們過多的去寫註釋呢?由於代碼即註釋
何爲代碼即註釋?代碼是具備自解釋功能的,高質量,命名規範的代碼,其實程序員應該一眼就可以看懂這段代碼的功能做用是什麼?
因此,程序員到底該不應寫註釋?
事實證實:該,可是要注意分寸。
1.優秀的程序員能夠少寫註釋~
優秀的程序員都是懶的。由於懶,他纔會寫出各類各樣的工具來替本身幹活。由於懶,他纔會想辦法避免去寫無聊重複的代碼——所以避免的代碼的冗餘,削減了代碼的維護成本,使重構變得更加容易。
代碼即註釋。做爲一個優秀的程序員,大多數都懂得註釋不是用來翻譯程序代碼的,用代碼能說清楚的東西,就天然不用費腦子去寫註釋了,集中精力寫出最優雅、高質量的代碼纔是首要的。自己對於簡短的代碼,規範的命名、條理清晰的書寫方式,讓人一看就懂,那麼自己這個代碼就不須要註釋,它自身就具備自解釋功能。
固然,若是一個函數上百行代碼,甚至更多,仍是須要寫必定的註釋的,甚至在一個重要的業務邏輯處理的地方,仍是須要註明一些註釋的,畢竟時間久了,業務邏輯不熟悉了,看代碼確實有些費勁。
2.初級中等程序員仍是得寫註釋~
做爲一個入門,初級或者中等的程序員,在本身代碼質量不高的階段,時刻提醒本身養成一個好的寫註釋的習慣仍是頗有必要的。
爲何不少程序員不肯意接手別人寫的代碼,是由於有一個問題就是必然存在的。每一個人的編碼風格不同,命名方式和規範不同,加上因爲程序員代碼的個性化,就造就了代碼的多樣性。假若再沒有註釋,誰還願意看?因此,前期記住必定得寫註釋。
記住:與人方便就是與己方便。
對,爲何談這個話題呢?由於有不少程序員寫代碼總有一種很是很是很差的習慣,那就是一段代碼不用了,註釋掉,可是他內心還總想着感受這段代碼之後可能還會用。因此就留着,不刪掉,但大多數狀況下,過幾天就忘了,結果代碼裏處處都是註釋,沒有一句是有用的。
接下來好了,接手的讀代碼的人也不敢刪,一直留着,留着,留着,留着……直到永遠。
大家大聲告訴我,大家是否是有這種習慣?是否是有這種心理?
我想說,註釋也是須要維護的。不少人都沒有意識到註釋維護的重要性。怎麼說呢?不寫註釋坑人,比不寫註釋更坑人的就是寫了註釋,功能變了,不修改註釋的人。
好比:
今天是程序員小王寫了一個處理業務邏輯的功能方法,功能是炒菜。過了兩個月後,需求變了,人家客戶不喜歡吃炒菜,須要換成了煮菜了。這時程序員小陳就在炒菜的功能方法上直接修改了,把功能改爲了煮菜。可是註釋上寫的仍是炒菜。又過了兩個月,客戶需求又變了,客戶吃膩了煮的菜,要求改爲蒸飯。
這時項目經理說:小郭,你把那個煮菜功能給我換成蒸飯。這時,程序員小郭,找啊找,找遍了註釋,發現沒有煮菜功能,一氣之下,算了,本身寫吧,本身又寫了一個蒸飯的功能函數。以後帶有炒菜註釋的煮菜功能,在接下來的一個又一個程序員都不敢刪,也無論了。
看到了,註釋不維護,是否是很很差。這只是其中一個方法,若是你修改了大部分的方法,又沒有修改註釋,接下來接手的程序員又不敢亂動,還看不懂,本身又從新寫,代碼冗餘,混亂不堪,以後愈來愈爛,代碼愈來愈沒人管了,也不想幹了。
嘔出一口老血!
代碼即註釋,寫註釋要注意分寸。以下:
► 用高質量的代碼代替註釋。
► 在複雜函數和重要的業務邏輯面試,仍是必需要寫註釋的。
► 註釋須要維護,不是寫了就好。不維護,還不如不寫。
►要學會命名,遵照規範,這樣纔可以培養出好習慣。
感謝你們能耐着性子,看完這篇文章。
在這裏我也分享一份本身收錄整理的Android學習PDF+架構視頻+面試文檔+源碼筆記,還有高級架構技術進階腦圖、Android開發面試專題資料,高級進階架構資料幫助你們學習提高進階,也節省你們在網上搜索資料的時間來學習,也能夠分享給身邊好友一塊兒學習
若是你有須要的話,能夠點贊,關注我,而後加入關注微信公衆號【Android開發之家】免費領取