如何寫出讓同事無(wú)法維護(hù)的代碼搓劫?

對(duì)瞧哟,你沒看錯(cuò),本文就是教你怎么寫出讓同事無(wú)法維護(hù)的代碼枪向。

程序命名

容易輸入的變量名比如:Fred勤揩,asdf

單字母的變量名比如:a,b秘蛔,c陨亡,x,y深员,z(如果不夠用负蠕,可以考慮 a1,a2倦畅,a3遮糖,a4,….)

有創(chuàng)意地拼寫錯(cuò)誤比如:SetPintleOpening叠赐, SetPintalClosing欲账,這樣可以讓人很難搜索代碼。

抽象比如:ProcessData芭概,DoIt赛不,GetData… 抽象到就跟什么都沒說(shuō)一樣。

縮寫比如:WTF罢洲,RTFSC …… (使用拼音縮寫也同樣給力踢故,比如: BT,TMD,TJJTDS)

隨機(jī)大寫字母比如:gEtnuMbER..

重用命名在內(nèi)嵌的語(yǔ)句塊中使用相同的變量名有奇效殿较。

使用重音字母比如:int ínt(第二個(gè) ínt 不是 int )

使用下劃線比如:_耸峭, __, ___斜脂。

使用不同的語(yǔ)言比如混用英語(yǔ)抓艳,德語(yǔ)触机,或是中文拼音帚戳。

使用字符命名比如:slash, asterix, comma…

使用無(wú)關(guān)的單詞比如:god, superman, iloveu….

混淆l和1字母 l 和數(shù)字 1 有時(shí)候是看不出來(lái)的。

偽裝欺詐

把注釋和代碼交織在一起

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è)以上的位置的程序。千萬(wàn)別把這個(gè)事寫在文檔中良狈。

注重細(xì)節(jié)當(dāng)你設(shè)計(jì)一個(gè)很復(fù)雜的算法的時(shí)候后添,你一定要把所有的詳細(xì)細(xì)設(shè)計(jì)都寫下來(lái),沒有 100 頁(yè)不能罷休薪丁,段落要有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() 千萬(wàn)不要注釋度衡單位茄蚯。

比如時(shí)間用的是秒還是毫秒,尺寸用的是像素還是英寸睦优,大小是 MB 還是 KB 等等渗常。另外,在你的代碼里汗盘,你可以混用不同的度衡單位皱碘,但也不要注釋。

Gotchas陷阱千萬(wàn)不要注釋代碼中的陷阱衡未。

在注釋和文檔中發(fā)泄不滿尸执。

程序設(shè)計(jì)

Java CastsJava 的類型轉(zhuǎn)型是天賜之物,每一次當(dāng)你從 Collectio n里取到一個(gè) object 的時(shí)候缓醋,你都需要把其轉(zhuǎn)回原來(lái)的類型如失。

因些,這些轉(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… 語(yǔ)句,相當(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)目后颂碧,沒有人可以通過繼承來(lái)擴(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(wú)法維護(hù)代碼的天賜之物,如果你有一個(gè)類有十個(gè)成為(變量和方法)你可以考慮寫 10 個(gè)層次的繼承贵白,然后把這十個(gè)屬性分別放在這十個(gè)層次中率拒。如果可能的話,把這十個(gè)類分別放在十個(gè)不同的文件中禁荒。

混亂你的代碼使用 XML猬膨,XML 的強(qiáng)大是無(wú)人能及的,使用 XML 你可以把本來(lái)只要 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 層的語(yǔ)句嵌套{},把嵌套的 if else 轉(zhuǎn)成 [? :] 也是一件很 NB 的事庶弃。

長(zhǎng)代碼行一行的代碼越長(zhǎng)越好衫贬,這樣別人閱讀時(shí)就需要來(lái)來(lái)回回的。

不要過早的return不要使用 break歇攻,這樣固惯,你就需要至少 5 層以上的 if-else 來(lái)處理錯(cuò)誤。

不要使用{}不要在 if else 使用{}缴守,尤其是在你重量地使用 if-else 嵌套時(shí)葬毫,你甚至可以在其中亂縮進(jìn)代碼镇辉,這樣一來(lái),就算是最有經(jīng)驗(yàn)的程序員也會(huì)踩上陷阱贴捡。

瑣碎的封裝比較封裝一個(gè) bool 類忽肛,類里面什么都做,就是一個(gè) bool烂斋。

循環(huán)千萬(wàn)不可用 for(int i=0; i<n; i++) 使用 while 代替 for屹逛,交換 n 和 i,把 < 改成 <=汛骂,使用 i– 調(diào)整步伐 罕模。

測(cè)試

從不測(cè)試千萬(wàn)不要測(cè)試任何的出錯(cuò)處理,從來(lái)也不檢測(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è)試自己的代碼的。

其他

你的老板什么都知道無(wú)論你的老板有多 SB敢伸,你都要嚴(yán)格地遵照他的旨意辦事扯饶,這樣一來(lái),你會(huì)學(xué)到更多的知識(shí)以及如何寫出更加無(wú)法維護(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

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末继榆,一起剝皮案震驚了整個(gè)濱河市巾表,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌略吨,老刑警劉巖集币,帶你破解...
    沈念sama閱讀 222,464評(píng)論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異翠忠,居然都是意外死亡鞠苟,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,033評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門秽之,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)当娱,“玉大人,你說(shuō)我怎么就攤上這事考榨】缦福” “怎么了?”我有些...
    開封第一講書人閱讀 169,078評(píng)論 0 362
  • 文/不壞的土叔 我叫張陵河质,是天一觀的道長(zhǎng)冀惭。 經(jīng)常有香客問我,道長(zhǎng)掀鹅,這世上最難降的妖魔是什么散休? 我笑而不...
    開封第一講書人閱讀 59,979評(píng)論 1 299
  • 正文 為了忘掉前任,我火速辦了婚禮淫半,結(jié)果婚禮上溃槐,老公的妹妹穿的比我還像新娘。我一直安慰自己科吭,他們只是感情好昏滴,可當(dāng)我...
    茶點(diǎn)故事閱讀 69,001評(píng)論 6 398
  • 文/花漫 我一把揭開白布猴鲫。 她就那樣靜靜地躺著,像睡著了一般谣殊。 火紅的嫁衣襯著肌膚如雪拂共。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,584評(píng)論 1 312
  • 那天姻几,我揣著相機(jī)與錄音宜狐,去河邊找鬼。 笑死蛇捌,一個(gè)胖子當(dāng)著我的面吹牛抚恒,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播络拌,決...
    沈念sama閱讀 41,085評(píng)論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼俭驮,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了春贸?” 一聲冷哼從身側(cè)響起混萝,我...
    開封第一講書人閱讀 40,023評(píng)論 0 277
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎萍恕,沒想到半個(gè)月后逸嘀,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,555評(píng)論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡允粤,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,626評(píng)論 3 342
  • 正文 我和宋清朗相戀三年崭倘,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片维哈。...
    茶點(diǎn)故事閱讀 40,769評(píng)論 1 353
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡绳姨,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出阔挠,到底是詐尸還是另有隱情,我是刑警寧澤脑蠕,帶...
    沈念sama閱讀 36,439評(píng)論 5 351
  • 正文 年R本政府宣布购撼,位于F島的核電站,受9級(jí)特大地震影響谴仙,放射性物質(zhì)發(fā)生泄漏迂求。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,115評(píng)論 3 335
  • 文/蒙蒙 一晃跺、第九天 我趴在偏房一處隱蔽的房頂上張望揩局。 院中可真熱鬧,春花似錦掀虎、人聲如沸凌盯。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,601評(píng)論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)驰怎。三九已至阐滩,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間县忌,已是汗流浹背掂榔。 一陣腳步聲響...
    開封第一講書人閱讀 33,702評(píng)論 1 274
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留症杏,地道東北人装获。 一個(gè)月前我還...
    沈念sama閱讀 49,191評(píng)論 3 378
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像厉颤,于是被迫代替她去往敵國(guó)和親穴豫。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,781評(píng)論 2 361

推薦閱讀更多精彩內(nèi)容

  • 對(duì),你沒看錯(cuò)翁逞,本文就是教你怎么寫出讓同事無(wú)法維護(hù)的代碼肋杖。 一、程序命名 容易輸入的變量名挖函。比如:Fred状植,asdf...
    皮皮塵啊閱讀 226評(píng)論 0 0
  • 對(duì)津畸,你沒看錯(cuò) 本文就是教你怎么寫出讓同事無(wú)法維護(hù)的代碼! 01 .程序命名 容易輸入的變量名必怜。比如:Fred肉拓,as...
    趙客縵胡纓v吳鉤霜雪明閱讀 478評(píng)論 2 9
  • 久違的晴天,家長(zhǎng)會(huì)梳庆。 家長(zhǎng)大會(huì)開好到教室時(shí)暖途,離放學(xué)已經(jīng)沒多少時(shí)間了。班主任說(shuō)已經(jīng)安排了三個(gè)家長(zhǎng)分享經(jīng)驗(yàn)膏执。 放學(xué)鈴聲...
    飄雪兒5閱讀 7,528評(píng)論 16 22
  • 今天感恩節(jié)哎驻售,感謝一直在我身邊的親朋好友。感恩相遇更米!感恩不離不棄欺栗。 中午開了第一次的黨會(huì),身份的轉(zhuǎn)變要...
    迷月閃星情閱讀 10,576評(píng)論 0 11
  • 可愛進(jìn)取,孤獨(dú)成精迟几。努力飛翔消请,天堂翱翔。戰(zhàn)爭(zhēng)美好瘤旨,孤獨(dú)進(jìn)取梯啤。膽大飛翔,成就輝煌存哲。努力進(jìn)取因宇,遙望,和諧家園祟偷〔旎可愛游走...
    趙原野閱讀 2,738評(píng)論 1 1