優秀的程序員真的不寫註釋嗎？

我在不少地方看到這樣一個觀點，「請中止寫註釋，由於只有爛的代碼才須要註釋。」這個觀點很是巧妙，它讓我想起了孟子的一句話，「楊氏爲我，是無君也；墨氏兼愛，是無父也。無父無君，是禽獸也。」

動不動就罵別人是「禽獸」，我總以爲有點不妥，這很不符合孟子的浩然之氣啊。有些大牛也有孟子這樣的覺悟，若是有人要他給本身的代碼加上註釋，就好像是對他的一種侮辱：「個人代碼寫得這麼優雅，你難道看不懂嗎？註釋是多餘的！」

我必須得認可，每一個程序員都應該有一顆追求「優雅」的心，力爭本身的代碼更易閱讀和理解——不僅是針對機器，還有咱們程序員同行。但不是每一個程序員在一開始都能寫出「高標準」的代碼的，就好像不是全部君王和百姓都能搞清楚孟子的治國齊家理念的。

在我剛回洛陽的那段時間，過得很是痛苦。由於我剛接手了別人留下的一個項目，關於大宗期貨交易的。後端代碼是用 Java 寫的，但有不少 bug 在裏面，動不動就資金結算失敗，甚至內存溢出，要解決這些問題，只有一個辦法，就是完全搞懂這些代碼。

不然，根本無從下手。這就好像，你和朋友開車出去自駕遊，去很遠很遠的地方，朋友開累了，須要休息，這時候，若是你沒考過駕照，那就抓瞎了，只能把車停路邊，等朋友的疲勞消退了，才能繼續上路。

我就抓瞎了。憑良心說，前同事留下的代碼是精彩絕倫的，若是換作是我來寫，真不必定能寫得出來。畢竟大宗期貨交易自己仍是有點難度的，須要競價撮合，這個業務理解起來比股票還要複雜些。

股票漲了就賺，跌了就虧。期貨不一樣的，買漲能賺，買跌也能賺。不過業務上的複雜仍是次要的，重要的是代碼裏的註釋很是稀有，就好像詹姆斯高斯林頭上的髮絲同樣稀有。

何況，國內程序員的英語功底你懂的，變量、方法、類、接口、枚舉的命名沒法作到真正意義上的名如其意。再加上，有些方法的行數多達三四百行，從頭看到尾，看得只想捶本身。

沒辦法，個人解決辦法就是，看懂一行就加一行註釋，畢竟註釋總比代碼要容易理解啊。就好像，咱們在調用一個不熟悉的 API 時，只要代碼的文檔說清楚它是幹嗎的，咱們就能夠用，就敢用，至於實現的細節，暫時沒有理解也不要緊。

差很少花了兩個月的時間（很是漫長、很是煎熬）吧，我總算是把項目中核心的代碼給研究清楚了。搞清楚以後，那些以前怎麼改都改不掉的 bug 也就迎刃而解了。

這也就是爲何，我倡導你們去讀源碼的一部分緣由了，除了學習，讀源碼是解決 bug 的殺手鐗。要讀懂源碼，註釋是必不可少的。不信，你看看 Java 的源碼，每一個變量、每一個方法、每一個類，註釋都很是詳細，詳細到你替源碼的做者感到心累。

在我看來，Java 源碼的做者絕對是這個世界上最優秀的程序員，連他們都寫註釋，那些聲稱「請中止寫註釋」的號召者是否是要啪啪啪地打臉，直到打腫爲止。

不要懷疑本身，寫註釋並不會證實你的代碼就是爛代碼。我相信，你應該買過電子產品，好比說鼠標、鍵盤、耳機、手機等等，全部的產品包裝裏除了產品自己，使用說明書是必不可少的。我就問一句，「手機沒有使用說明書，咱這些後浪還能不會用？」

寫註釋不是咱們的錯，軟件原本就是複雜的。尤爲是咱們這些英語不是主力語言的人來講，註釋顯得尤其重要。我可能屬於記憶力很差的那一種，隔個十天半個月，再去回頭看那些我本身敲的代碼，有時候真有點見着陌生人的感受：「這代碼是我寫的嗎？怎麼有點面生啊？」

大部分人寫的代碼都要升級重構，對吧？不管是語言自己版本的升級，仍是咱們自身能力的成長。假如在升級重構的時候，沒有這些註釋的幫助，真有點爬泰山的感受，累啊，親。

再者說，大牛也不敢保證本身的代碼是沒有問題的，對吧？但註釋是不會騙人的，它的意義是明確的。你可能會忘記代碼是幹嗎的，但我敢保證，註釋可以喚醒你的記憶。

寫出好的、有意義的註釋實際上是有難度的，就像寫代碼同樣。在追求卓越的路上，代碼和註釋實際上是相輔相成的。註釋會讓你的代碼更易閱讀，代碼會讓你的註釋更富有邏輯。

即使是你的代碼已經優雅到不須要註釋，那只是在你的層面上。對於你的同事，你代碼後來的負責者，就不必定了。所見略同的英雄並不會不少，你覺得很優雅的代碼沒準在別人眼裏就是一坨垃圾，而你的註釋極可能會幫助別人「恍然大悟」，明白代碼的意義。乖乖地寫註釋吧，對你對別人都有好處。

另外，我想說一句，註釋就好像是代碼的一個藍圖，也或者是對代碼的一個總結。在你寫代碼以前，腦子裏確定要想清楚你要實現什麼，怎麼實現，把這些做爲註釋寫下來絕對能夠幫助你寫出更優雅的代碼。在代碼寫完以後，經過註釋進行總結，還能對代碼進行一些昇華，沒準還能在總結的過程當中想到更好的代碼方案。

我還見到有大牛信誓旦旦地說，寫註釋就好像是給不會游泳的人扔一個救生圈，他永遠也學不會游泳。咋眼一看，這句話說得頗有道理，對吧？在大牛們看來，要讓一個新人快速成長，最好的辦法就是把沒有註釋的代碼扔給他看。

純屬扯淡，恐怕這個新人沒入門就放棄了吧？我已經三十一歲了，不，我已經十八歲了，還不會游泳呢？別聽那些大牛們的鬼話，我就不信，他本身沒寫過註釋。

總之一點，註釋並不會妨礙你寫出優雅簡潔的代碼，它只是程序固有的一部分而已。

若是以爲文章對你有點幫助，請微信搜索「 沉默王二 」第一時間閱讀，回覆「簡歷」更有一份 3000+ 人下載過的優質簡歷模板，今後你的簡歷不再會石沉大海了。本文已收錄 GitHub，傳送門~ ，裏面更有大廠面試完整考點，歡迎 Star。

我是沉默王二，一枚有顏值卻靠才華苟且的程序員。關注便可提高學習效率，別忘了三連啊，點贊、收藏、留言，我不挑，嘻嘻。