這樣可以寫出無法維護的程式碼

我把文章節選了一些，也並沒有完全翻譯，簡譯一下，也加入了一些自己的調侃。對於有下面這些程式設計習慣的朋友，請大家對號入座。另外，維護程式的朋友們，你們死定了!!

woodpeckerIf builders built buildings the way programmers write programs, then the first woodpecker that came along would destroy civilization. (如果建築師蓋房子就像程式設計師寫程式一樣，那麼，第一隻到來的啄木鳥就能毀掉我們的文明)

~ Gerald Weinberg (born: 1933-10-27 age: 77) Weinberg’s Second Law

程式命名

容易輸入的名字。比如：Fred，asdf

單字母的變數名。比如：a,b,c, x,y,z(陳皓注：如果不夠用，可以考慮a1,a2,a3,a4,….)

有創意地拼寫錯誤。比如：SetPintleOpening， SetPintalClosing。這樣可以讓人很難搜尋程式碼。

抽象。比如：ProcessData, DoIt, GetData… 抽象到就跟什麼都沒說一樣。

縮寫。比如：WTF，RTFSC …… (陳皓注：使用拼音縮寫也同樣給力，比如： BT，TMD，TJJTDS)

隨機大寫字母。比如：gEtnuMbER..

重用命名。在內嵌的語句塊中使用相同的變數名有奇效。

使用重音字母。比如：int ínt(注：第二個 ínt不是int)

使用下劃線。比如：_, __, ___。

使用不同的語言。比如混用英語，德語，或是中文拼音。

使用字元命名。比如：slash, asterix, comma…

使用無關的單詞。比如：god, superman, iloveu….

混淆l和1。字母l和數字1有時候是看不出來的。

偽裝欺詐

把註釋和程式碼交織在一起。

1 for(j=0; j<array_len; j+ =8)

2 {

3 total += array[j+0 ];

4 total += array[j+1 ];

5 total += array[j+2 ]; /* Main body of

6 total += array[j+3]; * loop is unrolled

7 total += array[j+4]; * for greater speed.

8 total += array[j+5]; */

9 total += array[j+6 ];

10 total += array[j+7 ];

11 }

隱藏宏定義。如：#define a=b a=0-b，當人們看到a=b時，誰也想不到那是一個宏。

換行。如下所示，下面的示例使用搜尋xy_z變得困難。

1 #define local_var xy\

2 _z // local_var OK

程式碼和顯示不一致。比如，你的介面顯示叫postal code，但是程式碼裡確叫 zipcode.

隱藏全域性變數。把使用全域性變數以函式引數的方式傳遞給函式，這樣可以讓人覺得那個變數不是全域性變數。

使用同意詞。如：

1 #define xxx global_var // in file std.h&nbsp;

2 #define xy_z xxx // in file ..\other\substd.h&nbsp;

3 #define local_var xy_z // in file ..\codestd\inst.h

使用相似的變數名。如：單詞相似，swimmer 和 swimner，字母相似：ilI1| 或 oO08。parselnt 和 parseInt， D0Calc 和 DOCalc。還有這一組：xy_Z, xy__z, _xy_z, _xyz, XY_Z, xY_z, Xy_z。

過載函式。使用相同的函式名，但是其功能和具體實現完全沒有關係。

運算子過載。過載運算子可以讓你的程式碼變得詭異，感謝CCTV，感謝C++。這個東西是可以把混亂程式碼提高到一種藝術的形式。比如：過載一個類的 ! 運算子，但實際功能並不是取反，讓其返回一個整數。於是，如果你使用 ! ! 運算子，那麼，有意思的事就發生了—— 先是呼叫類的過載 ! 運算子，然後把其返回的整數給 ! 成了 布林變數，如果是 !!! 呢?呵呵。

#define。看過本站那些混亂程式碼的文章，你都會知道宏定義和預編譯對於寫出不可讀的程式碼的重大意義。不過，一個具有想像力的東西是——在標頭檔案中使用預編譯來檢視這個標頭檔案被include了幾次，而被include不同的次數時，其中的函式定義完全不一樣。

1 #ifndef DONE

2 #ifdef TWICE

3 // put stuff here to declare 3rd time around

4 void g(char* str);

5 #define DONE

6 #else // TWICE

7 #ifdef ONCE

8 // put stuff here to declare 2nd time around<

9 void g(void* str);

10 #define TWICE

11 #else // ONCE

12 // put stuff here to declare 1st time around

13 void g(std::string str);

14 #define ONCE

15 #endif // ONCE

16 #endif // TWICE

17 #endif // DONE

文件和註釋

在註釋中撒謊。你不用真的去撒謊，只需在改程式碼的時候不要更新註釋就可以了。

註釋明顯的東西。比如：/* add 1 to i */。(參看本站的“五種應該避免的註釋”)

只註釋是什麼，而不是為什麼。

不要註釋秘密。如果你開發一個航班系統，請你一定要保證每有一個新的航班被加入，就得要修改25個以上的位置的程式。千萬別把這個事寫在文件中。

注重細節。當你設計一個很複雜的演算法的時候，你一定要把所有的詳細細設計都寫下來，沒有100頁不能罷休，段落要有5級以上，段落編號要有500個以上，例如：1.2.4.6.3.13 – Display all impacts for activity where selected mitigations can apply (short pseudocode omitted). 這樣，當你寫程式碼的時候，你就可以讓你的程式碼和文件一致，如：Act1_2_4_6_3_13()

千萬不要註釋度衡單位。比如時間用的是秒還是毫秒，尺寸用的是畫素還是英寸，大小是MB還是KB。等等。另外，在你的程式碼裡，你可以混用不同的度衡單位，但也不要註釋。

Gotchas。陷阱，千萬不要註釋程式碼中的陷阱。

在註釋和文件中發洩不滿。(參看本站的“五種應該避免的註釋”)

程式設計

Java Casts。Java的型別轉型是天賜之物。每一次當你從Collection裡取到一個object的時候，你都需要把其轉回原來的型別。因些，這些轉型操作會出現在N多的地方。如果你改變了型別，那麼你不一定能改變所有的地方。而編譯器可能能檢查到，也可能檢查不到。

利用Java的冗餘。比如：Bubblegum b = new Bubblegom(); 和 swimmer = swimner + 1; 注意變數間的細微差別。

從不驗證。從不驗證輸入的資料，從不驗證函式的返回值。這樣做可以向大家展示你是多麼的信任公司的裝置和其它程式設計師。

不要封裝。呼叫者需要知道被呼叫的所有的細節。

克隆和複製。為了效率，你要學會使用copy + paste。你幾乎都不用理解別人的程式碼，你就可以高效地程式設計了。(陳皓注：Copy + Paste出來的程式碼bug多得不能再多)

巨大的listener。寫一個listener，然後讓你的所有的button類都使用這個listener，這樣你可以在這個listener中整出一大堆if…else…語句，相當的刺激。

使用三維陣列。如果你覺得三維還不足夠，你可以試試四維。

混用。同時使用類的get/set方法和直接訪問那個public變數。這樣做的好處是可以極大的挫敗維護人員。

包裝，包裝，包裝。把你所有的API都包裝上6到8遍，包裝深度多達4層以上。然後包裝出相似的功能。

沒有秘密。把所有的成員都宣告成public的。這樣，你以後就很難限制其被人使用，而且這樣可以和別的程式碼造成更多的耦合度，可以讓你的程式碼存活得更久。

排列和阻礙。把drawRectangle(height, width) 改成 drawRectangle(width, height)，等release了幾個版本後，再把其改回去。這樣維護程式的程式設計師們將不能很快地明白哪一個是對的。

把變數改在名字上。例如，把setAlignment(int alignment)改成，setLeftAlignment, setRightAlignment, setCenterAlignment。

Packratting。保留你所有的沒有使用的和陳舊的變數，方法和程式碼。

That’s Final。Final你所有的子結點的類，這樣，當你做完這個專案後，沒有人可以透過繼承來擴充套件你的類。java.lang.String不也是這樣嗎?

避免使用介面。在java中，BS介面，在C++中BS使用虛擬函式。

避免使用layout。這樣就使得我們只能使用絕對座標。如果你的老大強制你使用layout，你可以考慮使用GridBagLayout，然後把grid座標hard code.

環境變數。如果你的程式碼需要使用環境變數。(getenv() – C++ / System.getProperty() – Java )，那麼，你應該把你的類的成員的初始化使用環境變數，而不是建構函式。

使用Magic number。參看《Linux一個插曲》。

使用全域性變數。1)把全域性變數的初始化放在不同的函式中，就算這個函式和這個變數沒有任何關係，這樣能夠讓我們的維護人員就像做偵探工作一樣。2)使用全域性變數可以讓你的函式的引數變得少一些。

配置檔案。配置檔案主要用於一些引數的初始化。在程式設計中，我們可以讓配置檔案中的引數名和實際程式中的名字不一樣。

膨脹你的類。讓你的類儘可能地擁有各種臃腫和晦澀的方法。比如，你的類只實現一種可能性，但是你要提供所有可能性的方法。不要定義其它的類，把所有的功能都放在一個類中。

使用子類。物件導向是寫出無法維護程式碼的天賜之物。如果你有一個類有十個成為(變數和方法)你可以考慮寫10個層次的繼承，然後把這十個屬性分別放在這十個層次中。如果可能的話，把這十個類分別放在十個不同的檔案中。

混亂你的程式碼

使用XML。XML的強大是無人能及的。使用XML你可以把本來只要10行的程式碼變成100行。而且，還要逼著別人也有XML。(參看，信XML得永生，信XML得自信)

混亂C程式碼。在《如何加密原始碼》中已經說過一些方法了，這裡再補充一些。

使用不同的進位制。比如：10 和010不是一樣的。再比如：array = new int[]{ 111, 120, 013, 121,};

儘量使用void*。然後把其轉成各種型別

使用隱式的轉型。C++的建構函式可以讓你神不知鬼不覺得完成轉型。

分解條件表示式。如：把 a==100分解成，a>99 && a<101

學會利用分號。如：if ( a );else;{ int d; d = c;}

間接轉型。如：把double轉string，寫成new Double(d).toString() 而不是 Double.toString(d)

大量使用巢狀。一個NB的程式設計師可以在一行程式碼上使用超過10層的小括號()，或是在一個函式里使用超過20層的語句巢狀{}，把巢狀的if else 轉成 [? :] 也是一件很NB的事。

使用C的變種陣列。myArray[i] 可以變成*(myArray + i) 也可以變成 *(i + myArray) 其等價於 i[myArray]。再看一個函式呼叫的示例，函式宣告：int myfunc(int q, int p) { return p%q; } 函式呼叫myfunc(6291, 8)[Array];

長程式碼行。一行的程式碼越長越好。這樣別人閱讀時就需要來來回回的

不要較早的return。不要使用goto，不要使用break，這樣，你就需要至少5層以上的if-else來處理錯誤。

不要使用{}。不要在if else使用{}，尤其是在你重量地使用if-else巢狀時，你甚至可以在其中亂縮排程式碼，這樣一來，就算是最有經驗的程式設計師也會踩上陷阱。

使用宏定義。宏定義絕對是混亂C/C++程式碼的最佳利器。參看 老手是這樣教新手程式設計的。

瑣碎的封裝。比較封裝一個bool類，類裡面什麼都做，就是一個bool.

迴圈。千萬不可用for(int i=0; i<n; i++)使用while代替for，交換n和i，把<改成<=，使用 i–調整步伐 。

測試

從不測試。千萬不要測試任何的出錯處理，從來也不檢測系統呼叫的返回值。

永遠不做效能測試。如果不夠快就告訴使用者換一個更快的機器。如果你一做測試，那麼就可能會要改你的演算法，甚至重設計，重新架構。

不要寫測試案例。不要做什麼程式碼覆蓋率測試，自動化測試。

測試是懦夫行為。一個勇敢的程式設計師是根本不需要這一步的。太多的程式太害怕他們的老闆，害怕失去工作，害怕使用者抱怨，甚至被起訴。這種擔心害怕直接影響了生產力。如果你對你的程式碼有強大的信心，那還要什麼測試呢?真正的程式設計師是不需要測試自己的程式碼的。

其它

你的老闆什麼都知道。無論你的老闆有多SB，你都要嚴格地遵照他的旨意辦事，這樣一來，你會學到更多的知識如何寫出無法維護的程式碼來的。

顛覆Help Desk。你要確保你那滿是bug的程式永遠不要被維護團隊知道。當使用者打電話和寫郵件給你的時候，你就不要理會，就算要理會，讓使用者重做系統或是告訴使用者其帳號有問題，是標準的回答。

閉嘴。對於一些像y2k這樣的大bug，你要學會守口如瓶，不要告訴任何人，包括你的親人好友以及公司的同事和管理層，這樣當到那一天的時候，你就可以用這個bug掙錢了。

忽悠。你會學會忽悠，就算你的程式碼寫得很爛，你也要為其掛上GoF設計模式的標籤，就算你的專案做得再爛，你也要為其掛上敏捷的標籤，只有學會像中國Thoughtworks的諮詢師那樣去忽悠，你才能學會更炫更酷的方法，讓整個團隊和公司，甚至整個業界都開始躁動，這樣才能真正為難維護的程式碼鋪平道路。

這個文件中還有很多很多，實在是太TMD強大了，大家自己去看看吧。有精力有能力的朋友不妨把其翻譯成中文。

總之，我們的口號是——

Write Everywhere, Read Nowher

這篇文章的原文在這裡()