如何寫出沒法維護的代碼

這篇文章的原文在這裏（mindprod.com/jgloss/unma…），我看完後我想說——

1. 什麼叫「創造力」，創造力就是——就算是要幹一件爛事都能幹得那麼漂亮那麼有創意的能力。
2. 什麼叫「抓狂」，抓狂就是——以一種沉着老練的不屈不撓的一本正經的精神一點一點把你推向崩潰的邊緣。

我把文章節選了一些，也並無徹底翻譯，簡譯一下，也加入了一些本身的調侃。對於有下面這些編程習慣的朋友，請你們對號入座。另外，維護程序的朋友們，大家死定了！！

If 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 2 3 4 5 6 7 8 9 10 11

for (j=0; j<array_len; j+ =8) { total += array[j+0 ]; total += array[j+1 ]; total += array[j+2 ]; /* Main body of total += array[j+3]; * loop is unrolled total += array[j+4]; * for greater speed. total += array[j+5]; */ total += array[j+6 ]; total += array[j+7 ]; }

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

• 換行。以下所示，下面的示例使用搜索xy_z變得困難。

1 2	#define local_var xy\ _z // local_var OK

• 代碼和顯示不一致。好比，你的界面顯示叫postal code，可是代碼裏確叫 zipcode.

• 隱藏全局變量。把使用全局變量以函數參數的方式傳遞給函數，這樣可讓人以爲那個變量不是全局變量。

• 使用贊成詞。如：

1 2 3

#define xxx global_var // in file std.h  #define xy_z xxx // in file ..\other\substd.h  #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。

• 重載函數。使用相同的函數名，可是其功能和具體實現徹底沒有關係。

插播福利

1.近期整理了20G資源，包含產品/運營/測試/程序員/市場等，互聯網從業者【工做必備乾貨技巧、行業專業書籍、面試真題寶典等】，獲取方式：

• 微信掃碼關注公衆號「非典型互聯網」，轉發文章到朋友圈，截圖發至公衆號後臺，便可獲取乾貨資源連接；

2.互聯網人交流羣：

• 關注公衆號「非典型互聯網」，在公衆號後臺回覆「入羣」，人脈共享，一塊兒交流；

• 操做符重載。重載操做符可讓你的代碼變得詭異，感謝CCTV，感謝C++。這個東西是能夠把混亂代碼提升到一種藝術的形式。好比：重載一個類的 ! 操做符，但實際功能並非取反，讓其返回一個整數。因而，若是你使用 ! ! 操做符，那麼，有意思的事就發生了—— 先是調用類的重載 ! 操做符，而後把其返回的整數給 ! 成了 布爾變量，若是是 !!! 呢？呵呵。

• #define。看過本站那些混亂代碼的文章，你都會知道宏定義和預編譯對於寫出不可讀的代碼的重大意義。不過，一個具備想像力的東西是——在頭文件中使用預編譯來查看這個頭文件被include了幾回，而被include不一樣的次數時，其中的函數定義徹底不同。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

#ifndef DONE #ifdef TWICE // put stuff here to declare 3rd time around void g( char * str); #define DONE #else // TWICE #ifdef ONCE // put stuff here to declare 2nd time around< void g( void * str); #define TWICE #else // ONCE // put stuff here to declare 1st time around void g(std::string str); #define ONCE #endif // ONCE #endif // TWICE #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 Nowhere

（全文完）

做者：陳皓，博客地址：https://coolshell.cn/articles/18190.html