【常見坑比代碼注意】如何寫出讓同事無法維護(hù)的代碼
注:這里轉(zhuǎn)載主要是方便大家以后盡可能避免這些情況,除非萬不得已,個(gè)人不提倡用下面些手段害人。

閱讀本文大概需要 6 分鐘。
原文:http://mindprod.com/jgloss/unmain.html
譯者:陳皓 (@左耳朵耗子)
譯文:http://coolshell.cn/articles/4758.html
對(duì),你沒看錯(cuò),本文就是教你怎么寫出讓同事無法維護(hù)的代碼。
一、程序命名
容易輸入的變量名。比如:Fred,asdf
單字母的變量名。比如:a,b,c,x,y,z(如果不夠用,可以考慮 a1,a2,a3,a4,….)
有創(chuàng)意地拼寫錯(cuò)誤。比如:SetPintleOpening, SetPintalClosing,這樣可以讓人很難搜索代碼。
抽象。比如:ProcessData,DoIt,GetData… 抽象到就跟什么都沒說一樣。
縮寫。比如:WTF,RTFSC …… (使用拼音縮寫也同樣給力,比如: BT,TMD,TJJTDS)
隨機(jī)大寫字母。比如:gEtnuMbER..
重用命名。在內(nèi)嵌的語句塊中使用相同的變量名有奇效。
使用重音字母。比如:int ínt(第二個(gè) ínt 不是 int )
使用下劃線。比如:_, __, ___。
使用不同的語言。比如混用英語,德語,或是中文拼音。
使用字符命名。比如:slash, asterix, comma…
使用無關(guān)的單詞。比如:god, superman, iloveu….
混淆l和1。字母 l 和數(shù)字 1 有時(shí)候是看不出來的。
二、偽裝欺詐
把注釋和代碼交織在一起。
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 ];}
代碼和顯示不一致。比如,你的界面顯示叫 postal code,但是代碼里確叫 zipcode。
隱藏全局變量。把使用全局變量以函數(shù)參數(shù)的方式傳遞給函數(shù),這樣可以讓人覺得那個(gè)變量不是全局變量。
使用相似的變量名。如:?jiǎn)卧~相似,swimmer 和 swimner,字母相似:ilI1| 或 oO08,parselnt 和 parseInt, D0Calc 和 DOCalc,還有這一組:xy_Z, xy__z, _xy_z, _xyz, XY_Z, xY_z, Xy_z。
重載函數(shù)。使用相同的函數(shù)名,但是其功能和具體實(shí)現(xiàn)完全沒有關(guān)系。
操作符重載。重載操作符可以讓你的代碼變得詭異,感謝 CCTV,感謝 C++,這個(gè)東西是可以把混亂代碼提高到一種藝術(shù)的形式。
比如:重載一個(gè)類的 ! 操作符,但實(shí)際功能并不是取反,讓其返回一個(gè)整數(shù)。
于是,如果你使用 ! ! 操作符,那么,有意思的事就發(fā)生了—— 先是調(diào)用類的重載 ! 操作符,然后把其返回的整數(shù)給 ! 成了 布爾變量,如果是 !!! 呢?呵呵。
三、文檔和注釋
在注釋中撒謊。你不用真的去撒謊,只需在改代碼的時(shí)候不要更新注釋就可以了。
注釋里面寫廢話。比如:/* add 1 to i */
只注釋是什么,而不是為什么。
不要注釋秘密。如果你開發(fā)一個(gè)航班系統(tǒng),請(qǐng)你一定要保證每有一個(gè)新的航班被加入,就得要修改 25 個(gè)以上的位置的程序。千萬別把這個(gè)事寫在文檔中。
注重細(xì)節(jié)。當(dāng)你設(shè)計(jì)一個(gè)很復(fù)雜的算法的時(shí)候,你一定要把所有的詳細(xì)細(xì)設(shè)計(jì)都寫下來,沒有 100 頁不能罷休,段落要有5級(jí)以上,段落編號(hào)要有 500 個(gè)以上。
例如:1.2.4.6.3.13 – Display all impacts for activity where selected mitigations can apply (short pseudocode omitted).。
這樣,當(dāng)你寫代碼的時(shí)候,你就可以讓你的代碼和文檔一致,如:Act1_2_4_6_3_13() 千萬不要注釋度衡單位。
比如時(shí)間用的是秒還是毫秒,尺寸用的是像素還是英寸,大小是 MB 還是 KB 等等。另外,在你的代碼里,你可以混用不同的度衡單位,但也不要注釋。
Gotchas。陷阱,千萬不要注釋代碼中的陷阱。
在注釋和文檔中發(fā)泄不滿。
四、程序設(shè)計(jì)
Java Casts。Java 的類型轉(zhuǎn)型是天賜之物,每一次當(dāng)你從 Collectio n里取到一個(gè) object 的時(shí)候,你都需要把其轉(zhuǎn)回原來的類型。
因些,這些轉(zhuǎn)型操作會(huì)出現(xiàn)在 N 多的地方。
如果你改變了類型,那么你不一定能改變所有的地方。而編譯器可能能檢查到,也可能檢查不到。
利用 Java 的冗余。比如:Bubblegum b = new Bubblegom(); 和 swimmer = swimner + 1; 注意變量間的細(xì)微差別。
從不驗(yàn)證。從不驗(yàn)證輸入的數(shù)據(jù),從不驗(yàn)證函數(shù)的返回值。這樣做可以向大家展示你是多么的信任公司的設(shè)備和其它程序員
不要封裝。調(diào)用者需要知道被調(diào)用的所有的細(xì)節(jié)。
克隆和拷貝。為了效率,你要學(xué)會(huì)使用 copy + past,你幾乎都不用理解別人的代碼,你就可以高效地編程了。
巨大的listener。寫一個(gè) listener,然后讓你的所有的 button 類都使用這個(gè) listener,這樣你可以在這個(gè) listener 中整出一大堆 if…else… 語句,相當(dāng)?shù)拇碳ぁ?/p>
使用三維數(shù)組。如果你覺得三維還不足夠,你可以試試四維。
混用。同時(shí)使用類的 get/set 方法和直接訪問那個(gè) public 變量,這樣做的好處是可以極大的挫敗維護(hù)人員。
包裝,包裝,包裝。把你所有的 API 都包裝上 6 到 8 遍,包裝深度多達(dá) 4層以上,然后包裝出相似的功能。
沒有秘密。把所有的成員都聲明成 public 的,這樣,你以后就很難限制其被人使用,而且這樣可以和別的代碼造成更多的耦合度,可以讓你的代碼存活得更久。
排列和阻礙。把drawRectangle(height, width) 改成 drawRectangle(width, height),等 release 了幾個(gè)版本后,再把其改回去,這樣維護(hù)程序的程序員們很快就不明白哪一個(gè)是對(duì)的。
把變量改在名字上。例如,把 setAlignment(int alignment) 改成,setLeftAlignment,setRightAlignment,setCenterAlignment。
保留你所有的沒有使用的和陳舊的變量,方法和代碼。
Final 你所有的子結(jié)點(diǎn)的類,這樣,當(dāng)你做完這個(gè)項(xiàng)目后,沒有人可以通過繼承來擴(kuò)展你的類。java.lang.String 不也是這樣嗎?
避免使用 layout。這樣就使得我們只能使用絕對(duì)坐標(biāo),如果你的老大強(qiáng)制你使用 layout,你可以考慮使用 GridBagLayout,然后把 grid 坐標(biāo) hard code。
環(huán)境變量。如果你的代碼需要使用環(huán)境變量,那么,你應(yīng)該把你的類的成員的初始化使用環(huán)境變量,而不是構(gòu)造函數(shù)。
使用全局變量。1)把全局變量的初始化放在不同的函數(shù)中,就算這個(gè)函數(shù)和這個(gè)變量沒有任何關(guān)系,這樣能夠讓我們的維護(hù)人員就像做偵探工作一樣。2)使用全局變量可以讓你的函數(shù)的參數(shù)變得少一些。
配置文件。配置文件主要用于一些參數(shù)的初始化,在編程中,我們可以讓配置文件中的參數(shù)名和實(shí)際程序中的名字不一樣。
膨脹你的類。讓你的類盡可能地?fù)碛懈鞣N臃腫和晦澀的方法,比如,你的類只實(shí)現(xiàn)一種可能性,但是你要提供所有可能性的方法。不要定義其它的類,把所有的功能都放在一個(gè)類中。
使用子類。面向?qū)ο笫菍懗鰺o法維護(hù)代碼的天賜之物,如果你有一個(gè)類有十個(gè)成為(變量和方法)你可以考慮寫 10 個(gè)層次的繼承,然后把這十個(gè)屬性分別放在這十個(gè)層次中。如果可能的話,把這十個(gè)類分別放在十個(gè)不同的文件中。
混亂你的代碼。使用 XML,XML 的強(qiáng)大是無人能及的,使用 XML 你可以把本來只要 10 行的代碼變成 100 行。而且,還要逼著別人也有 XML。(參看,信 XML 得永生,信 XML 得自信)
分解條件表達(dá)式。如:把 a==100 分解成,a>99 && a<101
學(xué)會(huì)利用分號(hào)。如:if ( a );else;{ int d; d = c;}
間接轉(zhuǎn)型。如:把 double 轉(zhuǎn) string,寫成 new Double(d).toString() 而不是 Double.toString(d)
大量使用嵌套。一個(gè) NB 的程序員可以在一行代碼上使用超過 10 層的小括號(hào)(),或是在一個(gè)函數(shù)里使用超過 20 層的語句嵌套{},把嵌套的 if else 轉(zhuǎn)成 [? :] 也是一件很 NB 的事。
長(zhǎng)代碼行。一行的代碼越長(zhǎng)越好,這樣別人閱讀時(shí)就需要來來回回的。
不要過早的return。不要使用 break,這樣,你就需要至少 5 層以上的 if-else 來處理錯(cuò)誤。
不要使用{}。不要在 if else 使用{},尤其是在你重量地使用 if-else 嵌套時(shí),你甚至可以在其中亂縮進(jìn)代碼,這樣一來,就算是最有經(jīng)驗(yàn)的程序員也會(huì)踩上陷阱。
瑣碎的封裝。比較封裝一個(gè) bool 類,類里面什么都做,就是一個(gè) bool。
循環(huán)。千萬不可用 for(int i=0; i<n; i++) 使用 while 代替 for,交換 n 和 i,把 < 改成 <=,使用 i– 調(diào)整步伐 。
五、測(cè)試
從不測(cè)試。千萬不要測(cè)試任何的出錯(cuò)處理,從來也不檢測(cè)系統(tǒng)調(diào)用的返回值。
永遠(yuǎn)不做性能測(cè)試。如果不夠快就告訴用戶換一個(gè)更快的機(jī)器。如果你一做測(cè)試,那么就可能會(huì)要改你的算法,甚至重設(shè)計(jì),重新架構(gòu)。
不要寫測(cè)試案例。不要做什么代碼覆蓋率測(cè)試,自動(dòng)化測(cè)試。
測(cè)試是懦夫行為。一個(gè)勇敢的程序員是根本不需要這一步的,太多的程序太害怕他們的老板,害怕失去工作,害怕用戶抱怨,甚至被起訴,這種擔(dān)心害怕直接影響了生產(chǎn)力。
如果你對(duì)你的代碼有強(qiáng)大的信心,那還要什么測(cè)試呢?真正的程序員是不需要測(cè)試自己的代碼的。
六、其他
你的老板什么都知道。無論你的老板有多 SB,你都要嚴(yán)格地遵照他的旨意辦事,這樣一來,你會(huì)學(xué)到更多的知識(shí)以及如何寫出更加無法維護(hù)的代碼。
顛覆Help Desk。你要確保你那滿是 bug 的程序永遠(yuǎn)不要被維護(hù)團(tuán)隊(duì)知道。當(dāng)用戶打電話和寫郵件給你的時(shí)候,你就不要理會(huì),就算要理會(huì),讓用戶重做系統(tǒng)或是告訴用戶其帳號(hào)有問題,是標(biāo)準(zhǔn)的回答。
閉嘴。對(duì)于一些像 y2k 這樣的大 bug,你要學(xué)會(huì)守口如瓶,不要告訴任何人,包括你的親人好友以及公司的同事和管理層,這樣當(dāng)?shù)侥且惶斓臅r(shí)候,你就可以用這個(gè) bug 掙錢了。
忽悠。你會(huì)學(xué)會(huì)忽悠,就算你的代碼寫得很爛,你也要為其掛上 GoF 設(shè)計(jì)模式的標(biāo)簽,就算你的項(xiàng)目做得再爛,你也要為其掛上敏捷的標(biāo)簽,讓整個(gè)團(tuán)隊(duì)和公司,甚至整個(gè)業(yè)界都開始躁動(dòng),這樣才能真正為難維護(hù)的代碼鋪平道路。
總之,我們的口號(hào)是—— Write Everywhere, Read Nowhere