如何編寫沒法維護的代碼 讓本身穩拿鐵飯碗 ;-)

如何編寫沒法維護的代碼

讓本身穩拿鐵飯碗 ;-)

Roedy Greenhtml

簡介

 

永遠不要(把本身遇到的問題)歸因於(他人的)惡意,這偏偏說明了(你本身的)無能。-- 拿破崙前端

 

爲了造福大衆,在Java編程領域創造就業機會,兄弟我在此傳授大師們的祕籍。這些大師寫的代碼極其難以維護,後繼者就是想對它作最簡單的修改都須要花上數年時間。並且,若是你能對照祕籍潛心修煉,你甚至能夠給本身弄個鐵飯碗,由於除了你以外,沒人能維護你寫的代碼。再並且,若是你能練就祕籍中的 所有 招式,那麼連你本身都沒法維護你的代碼了!java

你不想練功過分走火入魔吧。那就不要讓你的代碼 一眼看去 就徹底沒法維護,只要它 實質上是 那樣就好了。不然,你的代碼就有被重寫或重構的風險!程序員

整體原則

 

Quidquid latine dictum sit, altum sonatur.(隨便用拉丁文寫點啥都會顯得高大上。)算法

 

想挫敗維護代碼的程序員,你必須先明白他的思惟方式。他接手了你的龐大程序,沒有時間把它所有讀一遍,更別說理解它了。他無非是想快速找到修改代碼的位置、改代碼、編譯,而後就能交差,並但願他的修改不會出現意外的反作用。數據庫

他查看你的代碼不過是管中窺豹,一次只能看到一小段而已。你要確保他永遠看不到全貌。要儘可能和讓他難以找到他想找的代碼。但更重要的是,要讓他不能有把握 忽略 任何東西。編程

程序員都被編程慣例洗腦了,還爲此自鳴得意。每一次你處心積慮地違背編程慣例,都會迫使他必須用放大鏡去仔細閱讀你的每一行代碼。小程序

你可能會以爲每一個語言特性均可以用來讓代碼難以維護,其實否則。你必須精心地誤用它們才行。後端

命名

 

"當我使用一個單詞的時候" Humpty Dumpty 曾經用一種輕蔑的口氣說, "它就是我想表達的意思,很少也很多。「- Lewis Carroll -- 《愛麗絲魔鏡之旅》, 第6章數組

 

編寫沒法維護代碼的技巧的重中之重是變量和方法命名的藝術。如何命名是和編譯器無關的。這就讓你有巨大的自由度去利用它們迷惑維護代碼的程序員。

妙用 寶寶起名大全

買本寶寶起名大全,你就永遠不缺變量名了。好比  Fred 就是個好名字,並且鍵盤輸入它也省事。若是你就想找一些容易輸入的變量名,能夠試試  adsf

或者 

aoeu

之類。

單字母變量名

若是你給變量起名爲a,b,c,用簡單的文本編輯器就無法搜索它們的引用。並且,沒人能猜到它們的含義。

創造性的拼寫錯誤

若是你必須使用描述性的變量和函數名,那就把它們都拼錯。還能夠把某些函數和變量名拼錯,再把其餘的拼對(例如 SetPintleOpening 和 SetPintalClosing) ,咱們就能有效地將grep或IDE搜索技術玩弄於股掌之上。這招超級管用。還能夠混淆不一樣語言(好比colour -- 英國英語,和 color 

-- 美國英語)。

抽象

在命名函數和變量的時候,充分利用抽象單詞,例如 it, everything, data, handle, stuff, do, routine, perform 和數字,例如 e.g.  routineX48 , PerformDataFunction ,  DoIt ,  HandleStuff

還有 

do_args_method

首字母大寫的縮寫

用首字母大寫縮寫(好比GNU 表明 GNU's Not Unix) 使代碼簡潔難懂。真正的漢子(不管男女)歷來不說明這種縮寫的含義,他們生下來就懂。

辭典大輪換

爲了打破沉悶的編程氣氛,你能夠用一本辭典來查找儘可能多的同義詞。例如 display, show, present。在註釋裏含糊其辭地暗示這些命名之間有細微的差異,其實根本沒有。不過,若是有兩個命名類似的函數真的有重大差異,那卻是必定要確保它們用相同的單詞來命名(例如,對於 "寫入文件", "在紙上書寫" 和 "屏幕顯示" 都用 print 

來命名)。 在任何狀況下都不要屈服於編寫明確的項目詞彙表這種無理要求。你能夠辯解說,這種要求是一種不專業的行爲,它違反告終構化設計的信息隱藏原則。

首字母大寫

隨機地把單詞中間某個音節的首字母大寫。例如 

ComputeReSult()

重用命名

在語言規則容許的地方,儘可能把類、構造器、方法、成員變量、參數和局部變量都命名成同樣。更高級的技巧是在{}塊中重用局部變量。這樣作的目的是迫使維護代碼的程序員認真檢查每一個示例的範圍。特別是在Java代碼中,能夠把普通方法假裝成構造器。

使用非英語字母

在命名中偷偷使用不易察覺的非英語字母,例如

typedef struct { int i; } ínt;

看上去沒啥不對是吧?嘿嘿嘿...這裏的第二個 ínt 的   í

其實是東北歐字母,並非英語中的 i 。在簡單的文本編輯器裏,想看出這一點點區別幾乎是不可能的。

巧妙利用編譯器對於命名長度的限制

若是編譯器只區分命名的前幾位,好比前8位,那麼就把後面的字母寫得不同。好比,實際上是同一個變量,有時候寫成 var_unit_update() ,有時候又寫成 var_unit_setup(),看起來是兩個不一樣的函數調用。而在編譯的時候,它們實際上是同一個變量 

var_unit。

下劃線,一位真正的朋友

能夠拿 _ 和 __ 做爲標示符。

混合多語言

隨機地混用兩種語言(人類語言或計算機語言都行)。若是老闆要求使用他指定的語言,你就告訴他你用本身的語言更有利於組織你的思路,萬一這招無論用,就去控訴這是語言歧視,並威脅起訴老闆要求鉅額精神損失賠償。

擴展 ASCII 字符

擴展 ASCII 字符用於變量命名是徹底合法的,包括 ß, Ð, 和 ñ 等。在簡單的文本編輯器裏,除了拷貝/粘貼,基本上無法輸入。

其餘語言的命名

使用外語字典做爲變量名的來源。例如,能夠用德語單詞 punkt 代替 

point。除非維護代碼的程序員也像你同樣熟練掌握了德語. 否則他就只能盡情地在代碼中享受異域風情了。

數學命名

用數學操做符的單詞來命名變量。例如:

openParen = (slash asterix)  / equals;

(左圓括號 = (斜槓 星號)/等號;)

使人眩暈的命名

用帶有徹底不相關的感情色彩的單詞來命名變量。例如:

marypoppins = (superman starship)  / god;

(歡樂滿人間 = (超人 星河戰隊)/上帝;)

這一招可讓閱讀代碼的人陷入迷惑之中,由於他們在試圖想清楚這些命名的邏輯時,會不自覺地聯繫到不一樣的感情場景裏而沒法自拔。

什麼時候使用 i

永遠不要把  i 用做最內層的循環變量。 用什麼命名都行,就是別用 i

。把 

i

用在其餘地方就隨便了,用做非整數變量尤爲好。

慣例 -- 明修棧道,暗度陳倉

忽視 Java 編碼慣例,Sun 就是這樣作的。幸運的是,你違反了它編譯器也不會打小報告。這一招的目的是搞出一些在某些特殊狀況下有細微差異的名字來。若是你被強迫遵循駝峯法命名,你仍是能夠在某些模棱兩可的狀況下顛覆它。例如,input  F ile  name 和 input  f ile  N ame 

兩個命名均可以合法使用。在此基礎上本身發明一套複雜到變態的命名慣例,而後就能夠痛扁其餘人,說他們違反了慣例。

小寫的 l 看上去很像數字 1

用小寫字母 l 標識 long 常數。例如 10l 更容易被誤認爲是 101 而不是 10L 。 禁用全部能讓人準確區分 uvw wW gq9 2z 5s il17|!j oO08 `'" ;,. m nn rn {[()]} 的字體。要作個有創造力的人。

把全局命名重用爲私有

在A 模塊裏聲明一個全局數組,而後在B 模塊的頭文件裏在聲明一個同名的私有數組,這樣看起來你在B 模塊裏引用的是那個全局數組,其實卻不是。不要在註釋裏提到這個重複的狀況。

誤導性的命名

讓每一個方法都和它的名字蘊含的功能有一些差別。例如,一個叫 

isValid(x)

的方法在判斷完參數x的合法性以後,還順帶着把它轉換成二進制並保存到數據庫裏。

假裝

 

當一個bug須要越長的時間纔會暴露,它就越難被發現。- Roedy Green(本文做者)

 

編寫沒法維護代碼的另外一大祕訣就是假裝的藝術,即隱藏它或者讓它看起來像其餘東西。不少招式有賴於這樣一個事實:編譯器比肉眼或文本編輯器更有分辨能力。下面是一些假裝的最佳招式。

把代碼假裝成註釋,反之亦然

下面包括了一些被註釋掉的代碼,可是一眼看去卻像是正常代碼。
for(j  = 0; j  < array_len; j    = 8)

{

total  = array [ j 0  ] ; 

total  = array [ j 1  ] ; 

total  = array [ j 2  ] ; 

total  = array [ j 6  ] ; 

total  = array [ j 7  ] ; 

}

若是不是用綠色標出來,你能注意到這三行代碼被註釋掉了麼?

用鏈接符隱藏變量

對於下面的定義

#define local_var xy_z

能夠把 "xy_z" 打散到兩行裏:

#define local_var xy\_z // local_var OK

這樣全局搜索 xy_z 的操做在這個文件裏就一無所得了。 對於 C 預處理器來講,第一行最後的 "" 表示繼續拼接下一行的內容。

文檔

任何傻瓜都能說真話,而要把謊編圓則須要至關的智慧。- Samuel Butler (1835 - 1902)

不正確的文檔每每比沒有文檔還糟糕。- Bertrand Meyer

既然計算機是忽略註釋和文檔的,你就能夠在裏邊冠冕堂皇地編織彌天大謊,讓可憐的維護代碼的程序員完全迷失。

在註釋中撒謊

實際上你不須要主動地撒謊,只要沒有及時保持註釋和代碼更新的一致性就能夠了。

只記錄顯而易見的東西

往代碼裏摻進去相似於 這樣的註釋,可是永遠不要記錄包或者方法的總體設計這樣的乾貨。

記錄 How 而不是 Why

只解釋一個程序功能的細節,而不是它要完成的任務是什麼。這樣的話,若是出現了一個bug,修復者就搞不清這裏的代碼應有的功能。

該寫的別寫

好比你在開發一套航班預約系統,那就要精心設計,讓它在增長另外一個航空公司的時候至少有25處代碼須要修改。永遠不要在文檔裏說明要修改的位置。後來的開發人員要想修改你的代碼門都沒有,除非他們能把每一行代碼都讀懂。

計量單位

永遠不要在文檔中說明任何變量、輸入、輸出或參數的計量單位,如英尺、米、加侖等。計量單位對數豆子不是過重要,但在工程領域就至關重要了。同理,永遠不要說明任何轉換常量的計量單位,或者是它的取值如何得到。要想讓代碼更亂的話,你還能夠在註釋裏寫上錯誤的計量單位,這是赤裸裸的欺騙,可是很是有效。若是你想作一個惡貫滿盈的人,不妨本身發明一套計量單位,用本身或某個小人物的名字命名這套計量單位,但不要給出定義。萬一有人挑刺兒,你就告訴他們,你這麼作是爲了把浮點數運算湊成整數運算而進行的轉換。

永遠不要記錄代碼中的坑。若是你懷疑某個類裏可能有bug,天知地知你知就好。若是你想到了重構或重寫代碼的思路,看在老天爺的份上,千萬別寫出來。切記電影《小鹿斑比》裏那句臺詞 "若是你不能說好聽的話,那就什麼也不要說。"。萬一這段代碼的原做者看到你的註釋怎麼辦?萬一老闆看到了怎麼辦?萬一客戶看到了怎麼辦?搞很差最後你本身被解僱了。一句」這裏須要修改「的匿名註釋就好多了,尤爲是當看不清這句註釋指的是哪裏須要修改的狀況下。切記可貴糊塗四個字,這樣你們都不會感受受到了批評。

說明變量

永遠不要 對變量聲明加註釋。有關變量使用的方式、邊界值、合法值、小數點後的位數、計量單位、顯示格式、數據錄入規則等等,後繼者徹底能夠本身從程序代碼中去理解和整理嘛。若是老闆強迫你寫註釋,就把方法體代碼混進去,但絕對不要對變量聲明寫註釋,即便是臨時變量!

在註釋裏唆使離間

爲了阻撓任何僱傭外部維護承包商的傾向,能夠在代碼中散佈針對其餘同行軟件公司的攻擊和抹黑,特別是可能接替你工做的其中任何一家。例如:
class   clever_SSInc

{

. . .

}

可能的話,除了註釋以外,這些攻擊抹黑的內容也要摻到代碼裏的重要部分,這樣若是管理層想清理掉這些攻擊性的言論而後發給外部承包商去維護,就會破壞代碼結構。

程序設計

編寫沒法維護代碼的基本規則就是:在儘量多的地方,以儘量多的方式表述每個事實。- Roedy Green

編寫可維護代碼的關鍵因素是隻在一個地方表述應用裏的一個事實。若是你的想法變了,你也只在一個地方修改,這樣就能保證整個程序正常工做。因此,編寫沒法維護代碼的關鍵因素就是反覆地表述同一個事實,在儘量多的地方,以儘量多的方式進行。使人高興的是,像Java這樣的語言讓編寫這種沒法維護代碼變得很是容易。例如,改變一個被引用不少的變量的類型幾乎是不可能的,由於全部造型和轉換功能都會出錯,並且關聯的臨時變量的類型也不合適了。並且,若是變量值要在屏幕上顯示,那麼全部相關的顯示和數據錄入代碼都必須一一找到並手工進行修改。相似的還有不少,好比由C和Java組成的Algol語言系列,Abundance甚至Smalltalk對於數組等結構的處理,都是大有可爲的。

Java 造型

Java的造型機制是上帝的禮物。你能夠心安理得地使用它,由於Java語言自己就須要它。每次你從一個Collection 裏獲取一個對象,你都必須把它造型爲原始類型。這樣這個變量的類型就必須在無數地方表述。若是後來類型變了,全部的造型都要修改才能匹配。若是倒黴的維護代碼的程序員沒有找全(或者修改太多),編譯器能不能檢測到也很差說。相似的,若是變量類型從 short 變成  int ,全部匹配的造型也都要從(short)

改爲 

(int)

利用Java的冗餘

Java要求你給每一個變量的類型寫兩次表述。 Java 程序員已經習慣了這種冗餘,他們不會注意到你的兩次表述有細微的差異,例如

Bubblegum b = new Bubblegom();

不幸的是 操做符的盛行讓下面這種僞冗餘代碼得手的難度變大了:

swimmer = swimner 1;

永遠不作校驗

永遠不要對輸入數據作任何的正確性或差別性檢查。這樣能表現你對公司設備的絕對信任,以及你是一位信任全部項目夥伴和系統管理員的團隊合做者。老是返回合理的值,即便數據輸入有問題或者錯誤。

有禮貌,無斷言

避免使用 assert() 機制,由於它可能把三天的debug盛宴變成10分鐘的快餐。

避免封裝

爲了提升效率,不要使用封裝。方法的調用者須要全部能獲得的外部信息,以便了解方法的內部是如何工做的。

複製粘貼修改

以效率的名義,使用 複製 粘貼 修改。這樣比寫成小型可複用模塊效率高得多。在用代碼行數衡量你的進度的小做坊裏,這招尤爲管用。

使用靜態數組

若是一個庫裏的模塊須要一個數組來存放圖片,就定義一個靜態數組。沒人會有比512 X 512 更大的圖片,因此固定大小的數組就能夠了。爲了最佳精度,就把它定義成 double 類型的數組。

傻瓜接口

編寫一個名爲 "WrittenByMe" 之類的空接口,而後讓你的全部類都實現它。而後給全部你用到的Java 內置類編寫包裝類。這裏的思想是確保你程序裏的每一個對象都實現這個接口。最後,編寫全部的方法,讓它們的參數和返回類型都是這個 WrittenByMe。這樣就幾乎不可能搞清楚某個方法的功能是什麼,而且全部類型都須要好玩的造型方法。更出格的玩法是,讓每一個團隊成員編寫它們本身的接口(例如 WrittenByJoe),程序員用到的任何類都要實現他本身的接口。這樣你就能夠在大量無心義接口中隨便找一個來引用對象了。

巨型監聽器

永遠不要爲每一個組件建立分開的監聽器。對全部按鈕老是用同一個監聽器,只要用大量的if...else 來判斷是哪個按鈕被點擊就好了。

好事成堆TM

狂野地使用封裝和OO思想。例如

myPanel . add( getMyButton ( ) ); 

private JButton   getMyButton

()

{

return myButton; 

}

這段極可能看起來不怎麼可笑。別擔憂,只是時候未到而已。

友好的朋友

在C 裏儘可能多使用friend聲明。再把建立類的指針傳遞給已建立類。如今你不用浪費時間去考慮接口了。另外,你應該用上關鍵字private 和 protected 

來代表你的類封裝得很好。

使用三維數組

大量使用它們。用扭曲的方式在數組之間移動數據,好比,用arrayA裏的行去填充arrayB的列。這麼作的時候,無論三七二十一再加上1的偏移值,這樣很靈。讓維護代碼的程序員抓狂去吧。

混合與匹配

存取方法和公共變量神馬的都要給他用上。這樣的話,你無需調用存取器的開銷就能夠修改一個對象的變量,還能宣稱這個類是個"Java Bean"。對於那些試圖添加日誌函數來找出改變值的源頭的維護代碼的程序員,用這一招來迷惑他尤爲有效。

沒有祕密!

把每一個方法和變量都聲明爲 public。畢竟某我的某天可能會須要用到它。一旦方法被聲明爲public 了,就很難縮回去。對不?這樣任何它覆蓋到的代碼都很難修改了。它還有個使人愉快的反作用,就是讓你看不清類的做用是什麼。若是老闆質問你是否是瘋了,你就告訴他你遵循的是經典的透明接口原則。

全堆一塊

把你全部的沒用的和過期的方法和變量都留在代碼裏。畢竟提及來,既然你在1976年用過一次,誰知道你啥時候會須要再用到呢?固然程序是改了,但它也可能會改回來嘛,你"不想要從新發明輪子"(領導們都會喜歡這樣的口氣)。若是你還原封不動地留着這些方法和變量的註釋,並且註釋寫得又高深莫測,甭管維護代碼的是誰,恐怕都不敢對它輕舉妄動。

就是 Final

把你全部的葉子類都聲明爲 final。畢竟提及來,你在項目裏的活兒都幹完了,顯然不會有其餘人會經過擴展你的類來改進你的代碼。這種狀況甚至可能有安全漏洞。 java.lang.String 被定義成 final 也許就是這個緣由吧?若是項目組其餘程序員有意見,告訴他們這樣作可以提升運行速度。

避免佈局

永遠不要用到佈局。當維護代碼的程序員想增長一個字段,他必須手工調整屏幕上顯示全部內容的絕對座標值。若是老闆強迫你使用佈局,那就寫一個巨型的 GridBagLayout 並在裏面用絕對座標進行硬編碼。

全局變量,怎麼強調都不過度

若是上帝不肯意咱們使用全局變量,他就不會發明出這個東西。不要讓上帝失望,儘可能多使用全局變量。每一個函數最起碼都要使用和設置其中的兩個,即便沒有理由也要這麼作。畢竟,任何優秀的維護代碼的程序員都會很快搞清楚這是一種偵探工做測試,有利於讓他們從笨蛋中脫穎而出。

再一次說說全局變量

全局變量讓你能夠省去在函數裏描述參數的麻煩。充分利用這一點。在全局變量中選那麼幾個來表示對其餘全局變量進行操做的類型。

局部變量

永遠不要用局部變量。在你感受想要用的時候,把它改爲一個實例或者靜態變量,並沒有私地和其餘方法分享它。這樣作的好處是,你之後在其餘方法裏寫相似聲明的時候會節省時間。C 程序員能夠百尺竿頭更進一步,把全部變量都弄成全局的。

配置文件

配置文件一般是以 關鍵字 = 值 的形式出現。在加載時這些值被放入 Java 變量中。最明顯的迷惑技術就是把有細微差異的名字用於關鍵字和Java 變量.甚至能夠在配置文件裏定義運行時根本不會改變的常量。參數文件變量和簡單變量比,維護它的代碼量起碼是後者的5倍。

子類

對於編寫沒法維護代碼的任務來講,面向對象編程的思想簡直是天賜之寶。若是你有一個類,裏邊有10個屬性(成員/方法),能夠考慮寫一個基類,裏面只有一個屬性,而後產生9層的子類,每層增長一個屬性。等你訪問到最終的子類時,你才能獲得所有10個屬性。若是可能,把每一個類的聲明都放在不一樣的文件裏。

編碼迷局

迷惑 C

從互聯網上的各類混亂C 語言競賽中學習,追隨大師們的腳步。

追求極致

老是追求用最迷惑的方式來作普通的任務。例如,要用數組來把整數轉換爲相應的字符串,能夠這麼作:

char *p;

switch (n) 

case 1: 

p = "one"; 

if (0) 

case 2: 

p = "two"; 

if (0) 

case 3: 

p = "three"; 

printf("%s", p); 

break; 

}

一致性的小淘氣

當你須要一個字符常量的時候,能夠用多種不一樣格式: ' ', 32, 0x20, 040。在C或Java裏10和010是不一樣的數(0開頭的表示16進制),你也能夠充分利用這個特性。

造型

把全部數據都以 void * 形式傳遞,而後再造型爲合適的結構。不用結構而是經過位移字節數來造型也很好玩。

嵌套 Switch

Switch 裏邊還有 Switch,這種嵌套方式是人類大腦難以破解的。

利用隱式轉化

牢記編程語言中全部的隱式轉化細節。充分利用它們。數組的索引要用浮點變量,循環計數器用字符,對數字執行字符串函數調用。無論怎麼說,全部這些操做都是合法的,它們無非是讓源代碼更簡潔而已。任未嘗試理解它們的維護者都會對你感激涕零,由於他們必須閱讀和學習整個關於隱式數據類型轉化的章節,而這個章節極可能是他們來維護你的代碼以前徹底忽略了的。

分號!

在全部語法容許的地方都加上分號,例如:

if(a);

else;

{

int  d ; 

d  = c; 

;

使用八進制數

把八進制數混到十進制數列表裏,就像這樣:

array  = new int   [  ]

{

111 ,

120 ,

013 ,

121 ,

};

嵌套

儘量深地嵌套。優秀的程序員能在一行代碼裏寫10層(),在一個方法裏寫20層{}。

C數組

C編譯器會把  myArray  [i] 轉換成  *(myArray i) ,它等同於  *(i myArray)

也等同於 

i[myArray]

。 高手都知道怎麼用好這個招。能夠用下面的函數來產生索引,這樣就把代碼搞亂了:

int myfunc(int q, int p) { return p%q; }  
...  
myfunc(6291, 8)[Array];

遺憾的是,這一招只能在本地C類裏用,Java 還不行。

放長線釣大魚

一行代碼裏堆的東西越多越好。這樣能夠省下臨時變量的開銷,去掉換行和空格還能夠縮短源文件大小。記住,要去掉運算符兩邊的空格。優秀的程序員老是能突破某些編輯器對於255個字符行寬的限制。

異常

我這裏要向你傳授一個編程中不爲人知的祕訣。異常是個討厭的東西。良好的代碼永遠不會出錯,因此異常其實是沒必要要的。不要把時間浪費在這上面。子類異常是給那些知道本身代碼會出錯的低能兒用的。在整個應用裏,你只用在main()裏放一個try/catch,裏邊直接調用 System.exit()就好了。在每一個方法頭要貼上標準的拋出集合定義,到底會不會拋出異常你就不用管了。

使用異常的時機

在非異常條件下才要使用異常。好比終止循環就能夠用 

ArrayIndexOutOfBoundsException

。還能夠從異常裏的方法返回標準的結果。

狂熱奔放地使用線程

如題。

測試

在程序裏留些bug,讓後繼的維護代碼的程序員能作點有意思的事。精心設計的bug是無跡可尋的,並且誰也不知道它啥時候會冒出來。要作到這一點,最簡單的辦法的就是不要測試代碼。

永不測試

永遠不要測試負責處理錯誤、當機或操做系故障的任何代碼。反正這些代碼永遠也不會執行,只會拖累你的測試。還有,你怎麼可能測試處理磁盤錯誤、文件讀取錯誤、操做系統崩潰這些類型的事件呢?爲啥你要用特別不穩定的計算機或者用測試腳手架來模擬這樣的環境?現代化的硬件永遠不會崩潰,誰還願意寫一些僅僅用於測試的代碼?這一點也很差玩。若是用戶抱怨,你就怪到操做系統或者硬件頭上。他們永遠不會知道真相的。

永遠不要作性能測試

嘿,若是軟件運行不夠快,只要告訴客戶買個更快的機器就好了。若是你真的作了性能測試,你可能會發現一個瓶頸,這會致使修改算法,而後致使整個產品要從新設計。誰想要這種結果?並且,在客戶那邊發現性能問題意味着你能夠免費到外地旅遊。你只要備好護照和最新照片就好了。

永遠不要寫任何測試用例

永遠不要作代碼覆蓋率或路徑覆蓋率測試。自動化測試是給那些窩囊廢用的。搞清楚哪些特性佔到你的例程使用率的90%,而後把90%的測試用在這些路徑上。畢竟提及來,這種方法可能只測試到了大約你代碼的60%,這樣你就節省了40%的測試工做。這能幫助你遇上項目後端的進度。等到有人發現全部這些漂亮的「市場特性」不能正常工做的時候,你早就跑路了。一些有名的大軟件公司就是這樣測試代碼的,因此你也應該這樣作。若是由於某種緣由你還沒走,那就接着看下一節。

測試是給懦夫用的

勇敢的程序員會跳過這個步驟。太多程序員懼怕他們的老闆,懼怕丟掉工做,懼怕客戶的投訴郵件,懼怕遭到起訴。這種恐懼心理麻痹了行動,下降了生產率。有科學研究成果代表,取消測試階段意味着經理有把握能提早肯定交付時間,這對於規劃流程顯然是有利的。消除了恐懼心理,創新和實驗之花就隨之綻開。程序員的角色是生產代碼,調試工做徹底能夠由技術支持和遺留代碼維護組通力合做來進行。

若是咱們對本身的編程能力有充分信心,那麼測試就沒有必要了。若是咱們邏輯地看待這個問題,隨便一個傻瓜都能認識到測試根本都不是爲了解決技術問題,相反,它是一種感性的信心問題。針對這種缺少信心的問題,更有效的解決辦法就是徹底取消測試,送咱們的程序員去參加自信心培訓課程。畢竟提及來,若是咱們選擇作測試,那麼咱們就要測試每一個程序的變動,但其實咱們只須要送程序員去一次創建自信的培訓課就好了。很顯然這麼作的成本收益是至關可觀的。

編程語言的選擇

計算機語言正在逐步進化,變得更加傻瓜化。使用最新的語言是不人性的。儘量堅持使用你會用的最老的語言,先考慮用穿孔紙帶,不行就用匯編,再不行用FORTRAN 或者 COBOL,再不行就用C 還有 BASIC,實在不行再用 C 。

FØRTRAN

用 FORTRAN 寫全部的代碼。若是老闆問你爲啥,你能夠回答說有不少它很是有用的庫,你用了能夠節約時間。不過,用 FORTRAN 寫出可維護代碼的機率是0,因此,要達到不可維護代碼編程指南里的要求就容易多了。

用 ASM

把全部的通用工具函數都轉成彙編程序。

用 QBASIC

全部重要的庫函數都要用 QBASIC 寫,而後再寫個彙編的封包程序來處理 large 到 medium 的內存模型映射。

內聯彙編

在你的代碼裏混雜一些內聯的彙編程序,這樣很好玩。這年頭幾乎沒人懂彙編程序了。只要放幾行彙編代碼就能讓維護代碼的程序員望而卻步。

宏彙編調用C

若是你有個彙編模塊被C調用,那就儘量常常從彙編模塊再去調用C,即便只是出於微不足道的用途,另外要充分利用 goto, bcc 和其餘炫目的彙編祕籍。

與他人共事之道

老闆纔是真行家

若是你的老闆認爲他20年的 FORTRAN 編程經驗對於現代軟件開發具備很高的指導價值,你務必嚴格採納他的全部建議。投桃報李,你的老闆也會信任你。這會對你的職業發展有利。你還會從他那裏學到不少搞亂程序代碼的新方法。

顛覆技術支持

確保代碼中處處是bug的有效方法是永遠不要讓維護代碼的程序員知道它們。這須要顛覆技術支持工做。永遠不接電話。使用自動語音答覆「感謝撥打技術支持熱線。須要人工服務請按1,或在嘀聲後留言。」,請求幫助的電子郵件必須忽略,不要給它分配服務追蹤號。對任何問題的標準答覆是「我估計你的帳戶被鎖定了,有權限幫你恢復的人如今不在。」

沉默是金

永遠不要對下一個危機保持警覺。若是你預見到某個問題可能會在一個固定時間爆發,摧毀西半球的所有生命,不要公開討論它。不要告訴朋友、同事或其餘你認識的有本事的人。在任何狀況下都不要發表任何可能暗示到這種新的威脅的內容。只發送一篇正常優先級的、語焉不詳的備忘錄給管理層,保護本身免遭秋後算帳。若是可能的話,把這篇稀裏糊塗的信息做爲另一個更緊急的業務問題的附件。這樣就能夠問心無愧地休息了,你知道未來你被強制提早退休以後一段時間,他們又會求着你回來,並給你對數級增加的時薪!

每個月一書俱樂部

加入一個計算機每個月一書俱樂部。選擇那些看上去忙着寫書不可能有時間真的去寫代碼的做者。去書店裏找一些有不少圖表可是沒有代碼例子的書。瀏覽一下這些書,從中學會一些迂腐拗口的術語,用它們就能唬住那些自覺得是的維護代碼的程序員。你的代碼確定會給他留下深入印象。若是人們連你寫的術語都理解不了,他們必定會認爲你很是聰明,你的算法很是深奧。不要在你的算法說明裏做任何樸素的類比。

自立門戶

你一直想寫系統級的代碼。如今機會來了。忽略標準庫, 

編寫你本身的標準

,這將會是你簡歷中的一個亮點。

推出你本身的 BNF 範式

老是用你自創的、獨一無二的、無文檔的BNF範式記錄你的命令語法。永遠不要提供一套帶註解的例子(合法命令和非法命令之類)來解釋你的語法體系。那樣會顯得徹底缺少學術嚴謹性。確保沒有明顯的方式來區分終結符和中間符號。永遠不要用字體、顏色、大小寫和其餘任何視覺提示幫助讀者分辨它們。在你的 BNF 範式用和命令語言自己徹底同樣的標點符號,這樣讀者就永遠沒法分清一段 (...), [...], {...} 或 "..." 究竟是你在命令行裏真正輸入的,仍是想提示在你的BNF 範式裏哪一個語法元素是必需的、可重複的、或可選的。無論怎麼樣,若是他們太笨,搞不清你的BNF 範式的變化,就沒資格使用你的程序。

推出你本身的內存分配

地球人兒都知道,調試動態存儲是複雜和費時的。與其逐個類去確認它沒有內存溢出,還不如自創一套存儲分配機制呢。其實它無非是從一大片內存中 malloc 一塊空間而已。用不着釋放內存,讓用戶按期重啓動系統,這樣不就清除了堆麼。重啓以後系統須要追蹤的就那麼一點東西,比起解決全部的內存泄露簡單得不知道到哪裏去了!並且,只要用戶記得按期重啓系統,他們也永遠不會遇到堆空間不足的問題。一旦系統被部署,你很難想象他們還能改變這個策略。

其餘雜七雜八的招

 

若是你給某人一段程序,你會讓他困惑一天;若是你教他們如何編程,你會讓他困惑一生。-- Anonymous

 

  1. 不要重編譯

    讓咱們從一條多是有史以來最友好的技巧開始:把代碼編譯成可執行文件。若是它能用,就在源代碼裏作一兩個微小的改動 -- 每一個模塊都照此辦理。 可是不要費勁巴拉地再編譯一次了。  你能夠留着等之後有空並且須要調試的時候再說。多年之後,等可憐的維護代碼的程序員更改了代碼以後發現出錯了,他會有一種錯覺,以爲這些確定是他本身最近修改的。這樣你就能讓他毫無頭緒地忙碌很長時間。
  2. 挫敗調試工具

    對於試圖用行調試工具追蹤來看懂你的代碼的人,簡單的一招就能讓他狼狽不堪,那就是把每一行代碼都寫得很長。特別要把 then 語句 和 if 語句放在同一行裏。他們沒法設置斷點。他們也沒法分清在看的分支是哪一個 if 裏的。
  3. 公制和美製

    在工程方面有兩種編碼方式。一種是把全部輸入都轉換爲公制(米制)計量單位,而後在輸出的時候本身換算回各類民用計量單位。另外一種是從頭至尾都保持各類計量單位混合在一塊兒。老是選擇第二種方式,這就是美國之道!
  4. 持續改進

    要持續不懈地改進。要經常對你的代碼作出「改進」,並強迫用戶常常升級 -- 畢竟沒人願意用一個過期的版本嘛。即使他們以爲他們對現有的程序滿意了,想一想看,若是他們看到你又「完善「了它,他們會多麼開心啊!不要告訴任何人版本之間的差異,除非你被逼無奈 -- 畢竟,爲何要告訴他們原本永遠也不會注意到的一些bug呢?
  5. 」關於「

    」關於「一欄應該只包含程序名、程序員姓名和一份用法律用語寫的版權聲明。理想狀況下,它還應該連接到幾 MB 的代碼,產生有趣的動畫效果。可是,裏邊永遠不要包含程序用途的描述、它的版本號、或最新代碼修改日期、或獲取更新的網站地址、或做者的email地址等。這樣,全部的用戶很快就會運行在不一樣的版本上,在安裝N 1版以前就試圖安裝N 2版。
  6. 變動

    在兩個版本之間,你能作的變動天然是多多益善。你不會但願用戶年復一年地面對同一套老的接口或用戶界面,這樣會很無聊。最後,若是你能在用戶不注意的狀況下作出這些變動,那就更好了 -- 這會讓他們保持警戒,戒驕戒躁。
  7. 無需技能

    寫沒法維護代碼不須要多高的技能。喊破嗓子不如甩開膀子,無論三七二十一開始寫代碼就好了。記住,管理層還在按代碼行數考覈生產率,即便之後這些代碼裏的大部分都得刪掉。
  8. 只帶一把錘子

    一招鮮吃遍天,輕裝前進。若是你手頭只有一把錘子,那麼全部的問題都是釘子。
  9. 規範體系

    有可能的話,忽略當前你的項目所用語言和環境中被普羅大衆所接受的編程規範。好比,編寫基於MFC 的應用時,就堅持使用STL 編碼風格。
  10. 翻轉一般的 True False 慣例

    把經常使用的 true 和 false 的定義反過來用。這一招聽起來平淡無奇,可是每每收穫奇效。你能夠先藏好下面的定義:

    #define TRUE 0#define FALSE 1

    把這個定義深深地藏在代碼中某個沒人會再去看的文件裏不易被發現的地方,而後讓程序作下面這樣的比較

    if ( var == TRUE )

    if ( var != FALSE )

    某些人確定會火燒眉毛地跳出來「修正」這種明顯的冗餘,而且在其餘地方照着常規去使用變量var:

    if ( var )

    還有一招是爲  TRUE  和  FALSE 賦予相同的值,雖然大部分人可能會看穿這種騙局。給它們分別賦值 1 和 2 或者 -1 和 0 是讓他們瞎忙乎的方式裏更精巧的,並且這樣作看起來也不失對他們的尊重。你在Java 裏也能夠用這一招,定義一個叫 TRUE  

    的靜態常量。在這種狀況下,其餘程序員更有可能懷疑你乾的不是好事,由於Java裏已經有了內建的標識符 

    true

  11. 第三方庫

    在你的項目裏引入功能強大的第三方庫,而後不要用它們。潛規則就是這樣,雖然你對這些好的工具仍然一無所知,卻仍是能夠在你簡歷的「其餘工具」一節中寫上這些沒用過的庫。
  12. 不要用庫

    僞裝不知道有些庫已經直接在你的開發工具中引入了。若是你用VC 編程,忽略MFC 或 STL 的存在,手工編寫全部字符串和數組的實現;這樣有助於保持你的指針技術,並自動阻止任何擴展代碼功能的企圖。
  13. 建立一套Build順序

    把這套順序規則作得很是晦澀,讓維護者根本沒法編譯任何他的修改代碼。祕密保留 SmartJ ,它會讓  make 腳本形同廢物。相似地,偷偷地定義一個  javac  類,讓它和編譯程序同名。說到大招,那就是編寫和維護一個定製的小程序,在程序裏找到須要編譯的文件,而後經過直接調用  sun.tools.javac.Main  編譯類來進行編譯。
  14. Make 的更多玩法

    用一個 makefile-generated-batch-file 批處理文件從多個目錄複製源文件,文件之間的覆蓋規則在文檔中是沒有的。這樣,無需任何炫酷的源代碼控制系統,就能實現代碼分支,並阻止你的後繼者弄清哪一個版本的 DoUsefulWork() 纔是他須要修改的那個。
  15. 蒐集編碼規範

    儘量蒐集全部關於編寫可維護代碼的建議,例如 SquareBox 的建議 ,而後明目張膽地違反它們。
  16. 規避公司的編碼規則

    某些公司有嚴格的規定,不容許使用數字標識符,你必須使用預先命名的常量。要挫敗這種規定背後的意圖太容易了。好比,一位聰明的 C 程序員是這麼寫的:

    #define K_ONE 1

    #define K_TWO 2 

    #define K_THOUSAND 999

  17. 編譯器警告

    必定要保留一些編譯器警告。在 make 裏使用 「-」 前綴強制執行,忽視任何編譯器報告的錯誤。這樣,即便維護代碼的程序員不當心在你的源代碼裏形成了一個語法錯誤,make 工具仍是會從新把整個包build 一遍,甚至可能會成功!而任何程序員要是手工編譯你的代碼,看到屏幕上冒出一堆其實可有可無的警告,他們確定會以爲是本身搞壞了代碼。一樣,他們必定會感謝你讓他們有找錯的機會。學有餘力的同窗能夠作點手腳讓編譯器在打開編譯錯誤診斷工具時就無法編譯你的程序。固然了,編譯器也許能作一些腳本邊界檢查,可是真正的程序員是不用這些特性的,因此你也不應用。既然你用本身的寶貴時間就能找到這些精巧的bug,何須還畫蛇添足讓編譯器來檢查錯誤呢?
  18. 把 bug 修復和升級混在一塊兒

    永遠不要推出什麼「bug 修復"版本。必定要把 bug 修復和數據庫結構變動、複雜的用戶界面修改,還有管理界面重寫等混在一塊兒。那樣的話,升級就變成一件很是困難的事情,人們會慢慢習慣 bug 的存在並開始稱他們爲特性。那些真心但願改變這些」特性「的人們就會有動力升級到新版本。這樣從長期來講能夠節省你的維護工做量,並從你的客戶那裏得到更多收入。
  19. 在你的產品發佈每一個新版本的時候都改變文件結構

    沒錯,你的客戶會要求向上兼容,那就去作吧。不過必定要確保向下是不兼容的。這樣能夠阻止客戶重新版本回退,再配合一套合理的 bug 修復規則(見上一條),就能夠確保每次新版本發佈後,客戶都會留在新版本。學有餘力的話,還能夠想辦法讓舊版本壓根沒法識別新版本產生的文件。那樣的話,老版本系統不但沒法讀取新文件,甚至會否定這些文件是本身的應用系統產生的!舒適提示:PC 上的 Word 文字處理軟件就典型地精於此道。
  20. 抵消 Bug

    不用費勁去代碼裏找 bug 的根源。只要在更高級的例程里加入一些抵銷它的代碼就好了。這是一種很棒的智力測驗,相似於玩3D棋,並且能讓未來的代碼維護者忙乎很長時間都想不明白問題到底出在哪裏:是產生數據的低層例程,仍是莫名其妙改了一堆東西的高層代碼。這一招對天生須要多回合執行的編譯器也很好用。你能夠在較早的回合徹底避免修復問題,讓較晚的回合變得更加複雜。若是運氣好,你永遠都不用和編譯器前端打交道。學有餘力的話,在後端作點手腳,一旦前端產生的是正確的數據,就讓後端報錯。
  21. 使用旋轉鎖

    不要用真正的同步原語,多種多樣的旋轉鎖更好 -- 反覆休眠而後測試一個(non-volatile的) 全局變量,直到它符合你的條件爲止。相比系統對象,旋轉鎖使用簡便,」通用「性強,」靈活「多變,實爲居家旅行必備。
  22. 隨意安插 sync 代碼

    把某些系統同步原語安插到一些用不着它們的地方。本人曾經在一段不可能會有第二個線程的代碼中看到一個臨界區(critical section)代碼。本人當時就質問寫這段代碼的程序員,他竟然義正詞嚴地說這麼寫是爲了代表這段代碼是很」關鍵「(也是critical)的!
  23. 優雅降級

    若是你的系統包含了一套 NT 設備驅動,就讓應用程序負責給驅動分配 I/O 緩衝區,而後在任何交易過程當中對內存中的驅動加鎖,並在交易完成後釋放或解鎖。這樣一旦應用非正常終止,I/O緩存又沒有被解鎖,NT服務器就會當機。可是在客戶現場不太可能會有人知道怎麼弄好設備驅動,因此他們就沒有選擇(只能請你去免費旅遊了)。
  24. 定製腳本語言

    在你的 C/S 應用裏嵌入一個在運行時按字節編譯的腳本命令語言。
  25. 依賴於編譯器的代碼

    若是你發如今你的編譯器或解釋器裏有個bug,必定要確保這個bug的存在對於你的代碼正常工做是相當重要的。畢竟你又不會使用其餘的編譯器,其餘任何人也不容許!
  26. 一個貨真價實的例子

    下面是一位大師編寫的真實例子。讓咱們來瞻仰一下他在這樣短短几行 C 函數裏展現的高超技巧。

    void* Realocate(void*buf, int os, int ns)

    {

    void*temp;

    temp = malloc(os); 

    memcpy((void*)temp, (void*)buf, os); 

    free(buf); 

    buf = malloc(ns); 

    memset(buf, 0, ns); 

    memcpy((void*)buf, (void*)temp, ns); 

    return buf;

    }

    • 從新發明了標準庫裏已有的簡單函數。
    • Realocate 這個單詞拼寫錯誤。因此說,永遠不要低估創造性拼寫的威力。
    • 平白無故地給輸入緩衝區產生一個臨時的副本。
    • 平白無故地造型。 memcpy() 裏有 (void*),這樣即便咱們的指針已是 (void*) 了也要再造型一次。另外這樣能夠傳遞任何東西做爲參數,加10分。
    • 永遠沒必要費力去釋放臨時內存空間。這樣會致使緩慢的內存泄露,一開始看不出來,要程序運行一段時間才行。
    • 把用不着的東西也從緩衝區裏拷貝出來,以防萬一。這樣只會在Unix上產生core dump,Windows 就不會。
    • 很顯然,os 和 ns 的含義分別是」old size" 和 "new size"。
    • 給 buf 分配內存以後,memset 初始化它爲 0。不要使用 calloc(),由於某些人會重寫 ANSI 規範,這樣未來保不齊 calloc() 往 buf 裏填的就不是 0 了。(雖然咱們複製過去的數據量和 buf 的大小是同樣的,不須要初始化,不過這也無所謂啦)
  27. 如何修復 "unused variable" 錯誤

    若是你的編譯器冒出了 "unused local variable" 警告,不要去掉那個變量。相反,要找個聰明的辦法把它用起來。我最喜歡的方法是:  
    i = i;
  28. 大小很關鍵

    差點忘了說了,函數是越大越好。跳轉和 GOTO 語句越多越好。那樣的話,想作任何修改都須要分析不少場景。這會讓維護代碼的程序員陷入千頭萬緒之中。若是函數真的體型龐大的話,對於維護代碼的程序員就是哥斯拉怪獸了,它會在他搞清楚狀況以前就殘酷無情地將他們踩翻在地。
  29. 一張圖片頂1000句話,一個函數就是1000行

    把每一個方法體寫的儘量的長 -- 最好是你寫的任何方法或函數都沒有少於1000行代碼的,並且裏邊深度嵌套,這是必須的。
  30. 少個文件

    必定要保證一個或多個關鍵文件是找不到的。利用includes 裏邊再 includes 就能作到這一點。例如,在你的 main 模塊裏,你寫上:

    #include <stdcode.h>

    Stdcode.h 是有的。可是在 stdcode.h 裏,還有個引用:

    #include "a:\\refcode.h"

    而後,refcode.h 就沒地方能找到了。

  31. 處處可寫,無處可讀

    至少要把一個變量弄成這樣:處處被設置,可是幾乎沒有哪裏用到它。不幸的是,現代編譯器一般會阻止你作相反的事:處處讀,沒處寫。不過你在C 或 C 裏仍是能夠這樣作的。
原始博文發佈於: Roedy Green's Mindproducts ( http://mindprod.com/unmain.html  )。
相關文章
相關標籤/搜索