入門級的程式設計課程通常會教育學生們寫程式碼前先寫註釋、而且要儘量多註釋。 這種教育的出發點是“多註釋肯定比少註釋好、少註釋肯定比沒註釋好”。可不幸的是，很多的程式設計師把這當成了一種任務，對每一行程式碼都註釋一下。

寫這篇文章之前，我推薦下自己創的一個交流裙，每天群內直播分享課！我是一名從事了5年java開發的全棧工程師，目前在做線上教育講師，年初整理了一份最適合2018年學習的java乾貨，有想要學習Java的同學，關注小編頭條號，私信【學習】即可免費領取本文一整套系統的Java學習教程！

經過這樣的註釋，你否明白了這段程式碼是幹什麼的？的確，我也沒明白。 問題就在於，雖然有大量的註釋，可它們只是描述了程式碼是幹什麼了，卻沒有說明程式碼為什麼要這樣寫。

現在，請看一下我們採用另外一種方式對同一段程式碼進行的註釋:

如果有想學習java的程式設計師，可來我們的java學習扣qun：72340，3928免費送java的視訊教程噢！小編是一名5年java開發經驗的全棧工程師，整理了一份適合18年學習的java乾貨，送給每一位想學的小夥伴，歡迎大家一起學習哦。

這就好多了！也許我們還是不能完全明白這段程式碼的作用，但至少是有了一點方向了。

註釋是用來幫助讀者理解程式碼的，不是用來解釋語法的。 我可以大膽的認為，讀者對for迴圈的工作原理是瞭解的；所以沒必要寫這樣的註釋：“// 對客戶列表進行for迴圈操作”。讀者不明白的是你的程式碼是做什麼用的，你為什麼要採用這種方式實現它。

9. 干擾

很少有程式設計師能在眨眼之間從一種活動中轉換到程式設計的狀態中。通常情況下，我們更類似於需要慢慢啟動的火車，而不是能突然加速的 法拉利; 我們需要一定的時間才能進入工作狀態，一旦我們進入穩定有效的工作狀態，我們的工作效果和產出會很豐碩。 不幸的是，當思路不斷的被客戶、經理、以及你的同事打斷時，你的大腦很難進入程式設計的狀態。

8. 範圍蠕變（Scope creep）

範圍蠕變（Scope creep） (也稱作焦點蠕變（focus creep）， 需求蠕變（requirement creep）, 功能蠕變（feature creep），以及其它一些亂七八糟的演變詞語)，指在專案管理裡專案的需求變更失控。 當一個專案的範圍沒有明確的定義清楚、沒有文件化、不受控時就會出現這種現象。 這通常被認為是一種有負面影響的事情，應該盡力避免。

範圍蠕變通常會把一個簡單的需求變成一個複雜驚人的需要大量時間的巨無霸。 那些負責需求調研的傢伙們只需要敲幾下無辜的鍵盤就能把事情變成這樣：

版本 1: 顯示這個地區的地圖

版本 2: 顯示這個地區的地圖，要三維立體的

版本 3: 顯示這個地區的地圖，要三維立體的，而且能夠使用它作為飛行導航圖

一個本來30分鐘能完成的任務變成了一項要幾百人/天才能完成的超級複雜的系統。更糟糕的是，大多數情況下，需求變更是發生在開發階段 的，這樣一來你需要重寫程式碼，重新迴歸，有時要把前幾天才開發的程式碼刪除。

7. 管理者 — 完全不懂程式設計

管理工作不是一種簡單的工作。人是一種讓人很討厭的動物; 我們善變、喜怒無常，我們都自以為天下第一。想讓這樣的一群人都感到滿意和團結，你需要付出像山一樣大的努力。 然而，這並不意味著管理者就可以在對下屬的工作毫不理解的情況下進行管理。 當管理者對我們的工作沒有一點知識概念時，後果只會是需求頻繁變動，不現實的工期，普遍的挫折感（管理者和開發人員）。程式設計師們對此的抱怨相當普遍，這也是產生爭執不合的根源。

6. 寫文件

在說這個條目之前我先承認，我們確實有很多的文件生成工具，但據我的經驗，這些工具都是隻適合生成API文件，以供其他程式設計師參考。如果你開發 的軟體是平時人們每天都要用的，你必須要寫一些外行人(例如你的實施，客服等)都能理解的文件手冊。

我們可以很容易的看出，有些事情程式設計師們極不願意去做。 你可以簡單的回顧一下所有的開源專案。 人們百折不撓的對這些專案的一個索求是什麼：文件。

我敢打保票的說，不管在哪裡，至少會有一半的程式設計師當要求寫文件時會說：“不能讓其他人去寫嗎？“。

5. 程式 — 缺少文件

我可從來沒說過我們程式設計師是說一套做一套的人。 程式設計師們經常會在他們的專案裡用到第三方的類庫和應用。 於是，我們需要文件。 很不幸呀，就像我在第6條裡說的那樣，程式設計師們痛恨寫文件。這戲劇性的事情發生在我們自己身上。

當你需要使用一個第三方類庫時發現，至少有一半的API無從知道是幹什麼好用的，沒有任何事情比這個更打擊人的了。 函式 poorlyNamedFunctionA() 和函式 poorlyButSimilarlyNamedFunctionB() 有什麼區別？ 在我使用 PropertyX 屬性前是否需要測試一下它是不是 null 值？我估計只有通過自己的測試和報錯才能弄清楚!

4. 硬體

任何一個曾經被叫去除錯一個數據庫伺服器上奇怪的宕機現象，或是被叫去解決RAID驅動器不能正確的工作的問題的程式設計師，當發現是硬體問題時， 都會痛苦不已。 人們有一種普遍的誤解，認為程式設計師就是搞電腦的，他們肯定知道如何修理電腦。 不可否認，有些程式設計師確實是個全才，但我估計，絕大部分程式設計師都不知道，或者根本不關心當程式被編譯成機器碼後如何工作的。我們只關心做出來的東西是否符 合需求文件，這樣我們才能集中精力去解決這上層的任務。

3. 含糊不清

“網站宕機了”. “XX功能工作不正常”。 處理含糊不清的任務是種痛苦。 每次當非程式設計師被要求重現他們所遇到的問題時表現出的憤怒都讓我吃驚不已。 他們似乎不太明白，僅僅一句”它宕機了，修復它！”是無法讓我們開始工作的，我們需要更多的資訊。

軟體的執行是(大部分情況下)有跡可尋的。我們也樂見與此。 請遷就我們，幫我們指出是在哪個階段，什麼情況下出的問題，而不是簡單的說一句”修復它“。

2. 其他程式設計師

程式設計師經常和其他程式設計師合不來。詫異嗎，但這是真的。 這方面的事情我可以輕鬆的列出十大條，講細點甚至可以單獨寫篇部落格，所以這裡我只列出幾個常見的、讓其他同事感到懊惱的程式設計師的特徵：

脾氣暴躁以至態度極不友好。

不能明白什麼時候該去討論系統的架構，什麼時候是應該去動手去做。

無法進行有效的溝通，使用易於誤解的專業術語。

自己的事情處理不好。

對要做的程式和專案缺乏興趣。

那麼，這最後的，但不是最糟糕的，序號為1的讓程式設計師們煩惱的…

1. 自己寫的程式碼 — 6個月以後的

Don’t sneeze, I think I see a bug.

回顧一下自己以前寫的程式碼，是否也會愁眉苦臉？當時怎麼會這麼愚蠢！怎麼能編寫成這樣的東西！燒掉!丟到火裡！

現實是，軟體技術界是一個不斷變化的世界。 今天被看成是最好的方式，明天也許就會過時。 我們不可能寫出完美的程式碼，因為判斷我們的程式好壞的標準日新月異。 這令人很不爽，你的作品，今天看來是那麼的完美，但也許不久之後就會變成被人嘲笑的物件了。 真是讓人沮喪，因為不論我們如何努力的學習最新最棒的開發工具，設計，框架，以及開發方法，我們總是比最新的技術發展趨勢慢了一拍。 對於我來說，這是做一個程式設計師最苦惱的事情了。我們不斷的升級技術，是為了讓軟體更好，但卻禁不住感到，我就像一個做沙毯（sand-painting）的和尚。