對空骚,你沒看錯,本文就是教你怎么寫出讓同事無法維護的代碼金麸。
一卓囚、程序命名
容易輸入的變量名?。比如:Fred站蝠,asdf
單字母的變量名?汰具。比如:a,b,c, x,y,z(如果不夠用,可以考慮a1,a2,a3,a4,….)
有創(chuàng)意地拼寫錯誤?菱魔。比如:SetPintleOpening留荔, SetPintalClosing。這樣可以讓人很難搜索代碼澜倦。
抽象?聚蝶。比如:ProcessData, DoIt, GetData… 抽象到就跟什么都沒說一樣。
縮寫?藻治。比如:WTF碘勉,RTFSC …… (使用拼音縮寫也同樣給力,比如:BT桩卵,TMD验靡,TJJTDS)
隨機大寫字母?倍宾。比如:gEtnuMbER..
重用命名?。在內(nèi)嵌的語句塊中使用相同的變量名有奇效胜嗓。
使用重音字母?高职。比如:int ?ínt(第二個 ínt不是int)
使用下劃線?。比如:_, __, ___辞州。
使用不同的語言?怔锌。比如混用英語,德語孙技,或是中文拼音产禾。
使用字符命名?。比如:slash, asterix, comma…
使用無關(guān)的單詞?牵啦。比如:god, superman, iloveu….
混淆l和1?亚情。字母l和數(shù)字1有時候是看不出來的。?
二哈雏、偽裝欺詐
把注釋和代碼交織在一起楞件。
for(j=0;?j
{
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];?*forgreater?speed.
total?+=?array[j+5];?*/
total?+=?array[j+6?];
total?+=?array[j+7?];
}
代碼和顯示不一致?。比如裳瘪,你的界面顯示叫postal code土浸,但是代碼里確叫 zipcode.
隱藏全局變量?。把使用全局變量以函數(shù)參數(shù)的方式傳遞給函數(shù)彭羹,這樣可以讓人覺得那個變量不是全局變量黄伊。
使用相似的變量名?。如:單詞相似派殷,swimmer 和 swimner还最,字母相似:ilI1| 或 oO08。parselnt 和 parseInt毡惜, D0Calc 和 DOCalc拓轻。還有這一組:xy_Z, xy__z, _xy_z, _xyz, XY_Z, xY_z, Xy_z。
重載函數(shù)?经伙。使用相同的函數(shù)名扶叉,但是其功能和具體實現(xiàn)完全沒有關(guān)系。
操作符重載?帕膜。重載操作符可以讓你的代碼變得詭異枣氧,感謝CCTV,感謝C++垮刹。這個東西是可以把混亂代碼提高到一種藝術(shù)的形式作瞄。比如:重載一個類的 ! 操作符,但實際功能并不是取反危纫,讓其返回一個整數(shù)。于是,如果你使用 ! ! 操作符种蝶,那么契耿,有意思的事就發(fā)生了—— 先是調(diào)用類的重載 ! 操作符,然后把其返回的整數(shù)給 ! 成了 布爾變量螃征,如果是 !!! 呢搪桂?呵呵。
三盯滚、文檔和注釋
在注釋中撒謊?踢械。你不用真的去撒謊,只需在改代碼的時候不要更新注釋就可以了魄藕。
注釋里面寫廢話?内列。比如:/* add 1 to i */
只注釋是什么,而不是為什么?背率。
不要注釋秘密?话瞧。如果你開發(fā)一個航班系統(tǒng),請你一定要保證每有一個新的航班被加入寝姿,就得要修改25個以上的位置的程序交排。千萬別把這個事寫在文檔中。
注重細節(jié)?饵筑。當(dāng)你設(shè)計一個很復(fù)雜的算法的時候埃篓,你一定要把所有的詳細細設(shè)計都寫下來,沒有100頁不能罷休根资,段落要有5級以上架专,段落編號要有500個以上,例如:1.2.4.6.3.13 – Display all impacts for activity where selected mitigations can apply (short pseudocode omitted). 這樣嫂冻,當(dāng)你寫代碼的時候胶征,你就可以讓你的代碼和文檔一致,如:Act1_2_4_6_3_13()千萬不要注釋度衡單位桨仿。比如時間用的是秒還是毫秒睛低,尺寸用的是像素還是英寸,大小是MB還是KB服傍。等等钱雷。另外,在你的代碼里吹零,你可以混用不同的度衡單位罩抗,但也不要注釋。
Gotchas 灿椅。陷阱?套蒂,千萬不要注釋代碼中的陷阱钞支。
在注釋和文檔中發(fā)泄不滿?。?
四操刀、程序設(shè)計
Java Casts?烁挟。Java的類型轉(zhuǎn)型是天賜之物。每一次當(dāng)你從Collection里取到一個object的時候骨坑,你都需要把其轉(zhuǎn)回原來的類型撼嗓。因些,這些轉(zhuǎn)型操作會出現(xiàn)在N多的地方欢唾。如果你改變了類型且警,那么你不一定能改變所有的地方。而編譯器可能能檢查到礁遣,也可能檢查不到斑芜。
利用Java的冗余?。比如:Bubblegum b = new Bubblegom(); 和 swimmer = swimner + 1; 注意變量間的細微差別亡脸。
從不驗證?押搪。從不驗證輸入的數(shù)據(jù),從不驗證函數(shù)的返回值浅碾。這樣做可以向大家展示你是多么的信任公司的設(shè)備和其它程序員
不要封裝?大州。調(diào)用者需要知道被調(diào)用的所有的細節(jié)。
克隆和拷貝?垂谢。為了效率厦画,你要學(xué)會使用copy + paste。你幾乎都不用理解別人的代碼滥朱,你就可以高效地編程了根暑。
巨大的listener?。寫一個listener徙邻,然后讓你的所有的button類都使用這個listener排嫌,這樣你可以在這個listener中整出一大堆if…else…語句,相當(dāng)?shù)拇碳ぁ?/p>
使用三維數(shù)組?缰犁。如果你覺得三維還不足夠淳地,你可以試試四維。
混用?帅容。同時使用類的get/set方法和直接訪問那個public變量颇象。這樣做的好處是可以極大的挫敗維護人員。
包裝并徘,包裝遣钳,包裝?。把你所有的API都包裝上6到8遍麦乞,包裝深度多達4層以上蕴茴。然后包裝出相似的功能劝评。
沒有秘密?。把所有的成員都聲明成public的荐开。這樣付翁,你以后就很難限制其被人使用,而且這樣可以和別的代碼造成更多的耦合度晃听,可以讓你的代碼存活得更久。
排列和阻礙?砰识。把drawRectangle(height, width) 改成 drawRectangle(width, height)能扒,等release了幾個版本后,再把其改回去辫狼。這樣維護程序的程序員們很快就不明白哪一個是對的初斑。
把變量改在名字上?。例如膨处,把setAlignment(int alignment)改成见秤,setLeftAlignment, setRightAlignment, setCenterAlignment。
保留你所有的沒有使用的和陳舊的變量真椿,方法和代碼?鹃答。
Final你所有的子結(jié)點的類?,這樣突硝,當(dāng)你做完這個項目后测摔,沒有人可以通過繼承來擴展你的類。java.lang.String不也是這樣嗎解恰?
避免使用layout?锋八。這樣就使得我們只能使用絕對坐標。如果你的老大強制你使用layout护盈,你可以考慮使用GridBagLayout挟纱,然后把grid坐標hard code.
環(huán)境變量?。如果你的代碼需要使用環(huán)境變量腐宋。那么紊服,你應(yīng)該把你的類的成員的初始化使用環(huán)境變量,而不是構(gòu)造函數(shù)脏款。
使用全局變量?围苫。1)把全局變量的初始化放在不同的函數(shù)中,就算這個函數(shù)和這個變量沒有任何關(guān)系撤师,這樣能夠讓我們的維護人員就像做偵探工作一樣剂府。2)使用全局變量可以讓你的函數(shù)的參數(shù)變得少一些。
配置文件?剃盾。配置文件主要用于一些參數(shù)的初始化腺占。在編程中淤袜,我們可以讓配置文件中的參數(shù)名和實際程序中的名字不一樣。
膨脹你的類?衰伯。讓你的類盡可能地擁有各種臃腫和晦澀的方法铡羡。比如,你的類只實現(xiàn)一種可能性意鲸,但是你要提供所有可能性的方法烦周。不要定義其它的類,把所有的功能都放在一個類中怎顾。
使用子類?读慎。面向?qū)ο笫菍懗鰺o法維護代碼的天賜之物。如果你有一個類有十個成為(變量和方法)你可以考慮寫10個層次的繼承槐雾,然后把這十個屬性分別放在這十個層次中夭委。如果可能的話,把這十個類分別放在十個不同的文件中募强。
混亂你的代碼株灸。?使用XML。XML的強大是無人能及的擎值。使用XML你可以把本來只要10行的代碼變成100行慌烧。而且,還要逼著別人也有XML幅恋。(參看杏死,信XML得永生,信XML得自信)
分解條件表達式?捆交。如:把 a==100分解成淑翼,a>99 && a<101
學(xué)會利用分號?。如:if ( a );else;{ ?int d; ?d = c;}
間接轉(zhuǎn)型?品追。如:把double轉(zhuǎn)string玄括,寫成new Double(d).toString() 而不是 Double.toString(d)
大量使用嵌套?。一個NB的程序員可以在一行代碼上使用超過10層的小括號()肉瓦,或是在一個函數(shù)里使用超過20層的語句嵌套{}遭京,把嵌套的if else 轉(zhuǎn)成 [? :] 也是一件很NB的事。
長代碼行?泞莉。一行的代碼越長越好哪雕。這樣別人閱讀時就需要來來回回的
不要過早的return?。不要使用break鲫趁,這樣斯嚎,你就需要至少5層以上的if-else來處理錯誤。
不要使用{}。不要在if else使用{}?堡僻,尤其是在你重量地使用if-else嵌套時糠惫,你甚至可以在其中亂縮進代碼,這樣一來钉疫,就算是最有經(jīng)驗的程序員也會踩上陷阱硼讽。
瑣碎的封裝?。比較封裝一個bool類牲阁,類里面什么都做固阁,就是一個bool.
循環(huán)?。千萬不可用for(int i=0; i?
五咨油、測試
從不測試?您炉。千萬不要測試任何的出錯處理,從來也不檢測系統(tǒng)調(diào)用的返回值役电。
永遠不做性能測試?。如果不夠快就告訴用戶換一個更快的機器棉胀。如果你一做測試法瑟,那么就可能會要改你的算法,甚至重設(shè)計唁奢,重新架構(gòu)霎挟。
不要寫測試案例?。不要做什么代碼覆蓋率測試麻掸,自動化測試酥夭。
測試是懦夫行為?。一個勇敢的程序員是根本不需要這一步的脊奋。太多的程序太害怕他們的老板熬北,害怕失去工作,害怕用戶抱怨诚隙,甚至被起訴讶隐。這種擔(dān)心害怕直接影響了生產(chǎn)力。如果你對你的代碼有強大的信心久又,那還要什么測試呢巫延?真正的程序員是不需要測試自己的代碼的。
六地消、其他
你的老板什么都知道?炉峰。無論你的老板有多SB,你都要嚴格地遵照他的旨意辦事脉执,這樣一來疼阔,你會學(xué)到更多的知識以及如何寫出更加無法維護的代碼。
顛覆Help Desk?适瓦。你要確保你那滿是bug的程序永遠不要被維護團隊知道竿开。當(dāng)用戶打電話和寫郵件給你的時候谱仪,你就不要理會,就算要理會否彩,讓用戶重做系統(tǒng)或是告訴用戶其帳號有問題疯攒,是標準的回答。
閉嘴?列荔。對于一些像y2k這樣的大bug敬尺,你要學(xué)會守口如瓶,不要告訴任何人贴浙,包括你的親人好友以及公司的同事和管理層砂吞,這樣當(dāng)?shù)侥且惶斓臅r候,你就可以用這個bug掙錢了崎溃。
忽悠?蜻直。你會學(xué)會忽悠,就算你的代碼寫得很爛袁串,你也要為其掛上GoF設(shè)計模式的標簽概而,就算你的項目做得再爛,你也要為其掛上敏捷的標簽囱修,讓整個團隊和公司赎瑰,甚至整個業(yè)界都開始躁動,這樣才能真正為難維護的代碼鋪平道路破镰。
總之餐曼,我們的口號是——?Write Everywhere, Read Nowher
轉(zhuǎn)自:http://mindprod.com/jgloss/unmain.html
譯者:陳皓 (@左耳朵耗子)