無法維護的代碼寫法,但是反着來就會成爲一個好的程序員

前兩天,在公衆號看到了一篇“如何寫出讓同事無法維護的代碼?”(原文鏈接:https://mp.weixin.qq.com/s/AvJegwbjOkZdk-osZMyF8w)的文章,對於寫程序有了一些思考,剛開始看完後覺得非常搞笑,而且也非常厲害,但是反向思維一下,如果在寫程序的時候都避開這些東西,反着來,會不會成爲一個優秀的程序員。

以下爲文章原文(如侵犯到個人利益或者權限問題,可聯繫我刪除):

 

對,你沒看錯,本文就是教你怎麼寫出讓同事無法維護的代碼。


程序命名

 

  • 容易輸入的變量名比如: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有時候是看不出來的。

       

僞裝欺詐

 

 

  • 把註釋和代碼交織在一起。

  • 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.

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

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

  • 重載函數。使用相同的函數名,但是其功能和具體實現完全沒有關係。

  • 操作符重載。重載操作符可以讓你的代碼變得詭異,感謝CCTV,感謝C++。這個東西是可以把混亂代碼提高到一種藝術的形式。比如:重載一個類的 ! 操作符,但實際功能並不是取反,讓其返回一個整數。於是,如果你使用 ! ! 操作符,那麼,有意思的事就發生了—— 先是調用類的重載 ! 操作符,然後把其返回的整數給 ! 成了 布爾變量,如果是 !!! 呢?呵呵。

 

文檔和註釋

 

 

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

  • 註釋裏面寫廢話。比如:/* 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。你幾乎都不用理解別人的代碼,你就可以高效地編程了。

  • 巨大的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。

  • 保留你所有的沒有使用的和陳舊的變量,方法和代碼

  • Final你所有的子結點的類,這樣,當你做完這個項目後,沒有人可以通過繼承來擴展你的類。java.lang.String不也是這樣嗎?

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

  • 環境變量。如果你的代碼需要使用環境變量。那麼,你應該把你的類的成員的初始化使用環境變量,而不是構造函數。

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

  • 配置文件。配置文件主要用於一些參數的初始化。在編程中,我們可以讓配置文件中的參數名和實際程序中的名字不一樣。

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

  • 使用子類。面向對象是寫出無法維護代碼的天賜之物。如果你有一個類有十個成爲(變量和方法)你可以考慮寫10個層次的繼承,然後把這十個屬性分別放在這十個層次中。如果可能的話,把這十個類分別放在十個不同的文件中。

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

  • 分解條件表達式。如:把 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的事。

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

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

  • 不要使用{}。不要在if else使用{},尤其是在你重量地使用if-else嵌套時,你甚至可以在其中亂縮進代碼,這樣一來,就算是最有經驗的程序員也會踩上陷阱。

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

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


測試

 

  • 從不測試。千萬不要測試任何的出錯處理,從來也不檢測系統調用的返回值。

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

  • 不要寫測試案例。不要做什麼代碼覆蓋率測試,自動化測試。

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


其他

 

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

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

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

  • 忽悠。你會學會忽悠,就算你的代碼寫得很爛,你也要爲其掛上GoF設計模式的標籤,就算你的項目做得再爛,你也要爲其掛上敏捷的標籤,讓整個團隊和公司,甚至整個業界都開始躁動,這樣才能真正爲難維護的代碼鋪平道路。

 

總之,我們的口號是—— Write Everywhere, Read Nowhere

 

注:放在這裏,主要是爲自己備忘和參考,同時也方便大家的參考!

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章