我在很多地方看到這樣一個觀點，“請停止寫注釋，因為只有爛的代碼才需要注釋。”這個觀點非常巧妙，它讓我想起了孟子的一句話，“楊氏為我，是無君也；墨氏兼愛，是無父也。無父無君，是禽獸也。”
動不動就罵別人是“禽獸”，我總覺得有點不妥，這很不符合孟子的浩然之氣啊。有些大牛也有孟子這樣的覺悟，如果有人要他給自己的代碼加上注釋，就好像是對他的一種侮辱：“我的代碼寫得這么優雅，你難道看不懂嗎？注釋是多余的！”
我必須得承認，每個程序員都應該有一顆追求“優雅”的心，力爭自己的代碼更易閱讀和理解——不只是針對機器，還有我們程序員同行。但不是每個程序員在一開始都能寫出“高標准”的代碼的，就好像不是所有君王和百姓都能搞清楚孟子的治國齊家理念的。
在我剛回洛陽的那段時間，過得非常痛苦。因為我剛接手了別人留下的一個項目，關於大宗期貨交易的。后端代碼是用 Java 寫的，但有很多 bug 在里面，動不動就資金結算失敗，甚至內存溢出，要解決這些問題，只有一個辦法，就是徹底搞懂這些代碼。
否則，根本無從下手。這就好像，你和朋友開車出去自駕游，去很遠很遠的地方，朋友開累了，需要休息，這時候，如果你沒考過駕照，那就抓瞎了，只能把車停路邊，等朋友的疲勞消退了，才能繼續上路。
我就抓瞎了。憑良心說，前同事留下的代碼是精彩絕倫的，如果換做是我來寫，真不一定能寫得出來。畢竟大宗期貨交易本身還是有點難度的，需要競價撮合，這個業務理解起來比股票還要復雜些。
股票漲了就賺，跌了就虧。期貨不同的，買漲能賺，買跌也能賺。不過業務上的復雜還是次要的，重要的是代碼里的注釋非常稀有，就好像詹姆斯高斯林頭上的發絲一樣稀有。
況且，國內程序員的英語功底你懂的，變量、方法、類、接口、枚舉的命名無法做到真正意義上的名如其意。再加上，有些方法的行數多達三四百行，從頭看到尾，看得只想捶自己。
沒辦法，我的解決辦法就是，看懂一行就加一行注釋，畢竟注釋總比代碼要容易理解啊。就好像，我們在調用一個不熟悉的 API 時，只要代碼的文檔說清楚它是干嘛的，我們就可以用，就敢用，至於實現的細節，暫時沒有理解也沒關系。
差不多花了兩個月的時間（非常漫長、非常煎熬）吧，我總算是把項目中核心的代碼給研究清楚了。搞清楚之后，那些之前怎么改都改不掉的 bug 也就迎刃而解了。
這也就是為什么，我倡導大家去讀源碼的一部分原因了，除了學習，讀源碼是解決 bug 的殺手鐧。要讀懂源碼，注釋是必不可少的。不信，你看看 Java 的源碼，每個變量、每個方法、每個類，注釋都非常詳細，詳細到你替源碼的作者感到心累。
在我看來，Java 源碼的作者絕對是這個世界上最優秀的程序員，連他們都寫注釋，那些聲稱“請停止寫注釋”的號召者是不是要啪啪啪地打臉，直到打腫為止。
不要懷疑自己，寫注釋並不會證明你的代碼就是爛代碼。我相信，你應該買過電子產品，比如說鼠標、鍵盤、耳機、手機等等，所有的產品包裝里除了產品本身，使用說明書是必不可少的。我就問一句，“手機沒有使用說明書，咱這些后浪還能不會用？”
寫注釋不是我們的錯，軟件本來就是復雜的。尤其是我們這些英語不是主力語言的人來說，注釋顯得尤為重要。我可能屬於記憶力不好的那一種，隔個十天半個月，再去回頭看那些我自己敲的代碼，有時候真有點見着陌生人的感覺：“這代碼是我寫的嗎？怎么有點面生啊？”
大部分人寫的代碼都要升級重構，對吧？不論是語言本身版本的升級，還是我們自身能力的成長。假如在升級重構的時候，沒有這些注釋的幫助，真有點爬泰山的感覺，累啊，親。
再者說，大牛也不敢保證自己的代碼是沒有問題的，對吧？但注釋是不會騙人的，它的意義是明確的。你可能會忘記代碼是干嘛的，但我敢保證，注釋能夠喚醒你的記憶。
寫出好的、有意義的注釋其實是有難度的，就像寫代碼一樣。在追求卓越的路上，代碼和注釋其實是相輔相成的。注釋會讓你的代碼更易閱讀，代碼會讓你的注釋更富有邏輯。
即便是你的代碼已經優雅到不需要注釋，那只是在你的層面上。對於你的同事，你代碼后來的負責者，就不一定了。所見略同的英雄並不會很多，你以為很優雅的代碼沒准在別人眼里就是一坨垃圾，而你的注釋很可能會幫助別人“恍然大悟”，明白代碼的意義。乖乖地寫注釋吧，對你對別人都有好處。
另外，我想說一句，注釋就好像是代碼的一個藍圖，也或者是對代碼的一個總結。在你寫代碼之前，腦子里肯定要想清楚你要實現什么，怎么實現，把這些作為注釋寫下來絕對可以幫助你寫出更優雅的代碼。在代碼寫完之后，通過注釋進行總結，還能對代碼進行一些升華，沒准還能在總結的過程中想到更好的代碼方案。
我還見到有大牛信誓旦旦地說，寫注釋就好像是給不會游泳的人扔一個救生圈，他永遠也學不會游泳。咋眼一看，這句話說得很有道理，對吧？在大牛們看來，要讓一個新人快速成長，最好的辦法就是把沒有注釋的代碼扔給他看。
純屬扯淡，恐怕這個新人沒入門就放棄了吧？我已經三十一歲了，不，我已經十八歲了，還不會游泳呢？別聽那些大牛們的鬼話，我就不信，他自己沒寫過注釋。
總之一點，注釋並不會妨礙你寫出優雅簡潔的代碼，它只是程序固有的一部分而已。
如果覺得文章對你有點幫助，請微信搜索「 沉默王二 」第一時間閱讀，回復「簡歷」更有一份 3000+ 人下載過的優質簡歷模板，從此你的簡歷再也不會石沉大海了。本文已收錄 GitHub，傳送門~ ，里面更有大廠面試完整考點，歡迎 Star。
我是沉默王二，一枚有顏值卻靠才華苟且的程序員。關注即可提升學習效率，別忘了三連啊，點贊、收藏、留言，我不挑，嘻嘻。