程式員的10大煩惱



10. 注釋 — 隻解釋了“how”卻沒有解釋“why”

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

Java r = n / 2; // 讓 r 等于 n 除以 2

// 當 r - (n/r) 大于 t 時進行循環

while ( abs( r - (n/r) ) > t ) {

r = 0.5 * ( r + (n/r) ); // 設定 r 等于 r + (n/r) 的一半

}

1 2 3 4 5 6

r = n / 2 ; // 讓 r 等于 n 除以 2   // 當 r - (n/r) 大于 t 時進行循環   while ( abs ( r - ( n / r ) ) > t ) {    r = 0.5 * ( r + ( n / r ) ) ; // 設定 r 等于 r + (n/r) 的一半   }

經過這樣的注釋，你否明白了這段代碼是幹什麼的？的确，我也沒明白。 問題就在于，雖然有大量的注釋，可它們隻是描述了代碼是幹什麼了，卻沒有說明代碼為什麼要這樣寫。

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

Java // 使用牛頓-Raphson算法求n的平方根近似值

r = n / 2;

while ( abs( r - (n/r) ) > t ) {

r = 0.5 * ( r + (n/r) );

}

1 2 3 4 5 6

// 使用牛頓-Raphson算法求n的平方根近似值   r = n / 2 ;    while ( abs ( r - ( n / r ) ) > t ) {    r = 0.5 * ( r + ( n / r ) ) ;    }

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

注釋是用來幫助讀者了解代碼的，不是用來解釋文法的。 我可以大膽的認為，讀者對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）的和尚。