思考:如何寫出讓同事難以維護的代碼?doge

摘要概覽

比起什麼程序員刪庫跑路,我更喜歡「寫出讓同事難以維護的代碼」,因爲即使不能「名垂千古」,至少VCS可以幫你「遺臭萬年」。

‍本文從【程序命名&註釋】【數據類型&類&對象】【控制執行流程】和【程序/結構設計】四個方面梳理了一些真實案例,相信通過這些案例你能迅速get技能:如何寫出讓同事難以維護的代碼doge。說回正題,前幾天在家附近的一個小學校旁邊散步,突然聽到某個學生說“上學期我是‘三好學生’,xxxx”。想了想,學生有“三好”,那麼程序員“三好”是什麼?我認爲程序員的“三好”是「好用」,「好看」,「好改」。這個是說程序員的代碼:

  • 要正確且健壯,就是好用;
  • 要可讀性高,易於理解,就是好看;
  • 要方便擴展和改動,就是好改;

平時不少文章都在聊“三好”的正例,今天理一些「好看」的反例,希望給讀者一些啓發和印象,避免編碼中的一些問題,爭取做個“三好程序員”吧。

一、程序命名&註釋

1.1教你如何挑戰維護者

容易輸入的變量名

比如:Fred,asdf單字母的變量名。比如:a,b,c,x,y,z(如果不夠用,可以考慮 a1,a2,a3,a4,….)

有創意地拼寫錯誤

比如:SetPintleOpening, SetPintalClosing,這樣可以讓人很難搜索代碼。

使用縮寫和拼音

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

論註釋的重要性:不然我以爲是「駕校」是一類重要客戶,要有單獨的helper

1.2嵌入式文檔之殤=註釋

不要盲目修改,注意理解!!!

注意理解,你會發現其中的不同點……

「注意理解」之後,意外出現了……

程序回憶錄

long~ long ago~【狼,狼,啊狗】

千萬注意something

實在不知道注意什麼……

用註釋保留一些祕密

二、數據類型&類&對象

2.1教教你怎麼用數組

無所不能的多維數組

如果你覺得二維、三維還不足夠,你可以試試四維。

仔細品一品,這個排版和換行可以教你快速數下標的方法:行號-44,比如“常駐工作城市”的下標就是25。

想清楚下標了再調用

一切皆對象,數組也是對象,用就是了

2.2對象?"類"覺不愛

員工服務的四胞胎:倆哥哥service,倆妹妹helper;

——「木蘭辭」:"四"兔傍地走,安能辨我是雌雄雄雌;

三、控制執行流程

3.1開胃菜:if-else

巨大的processor。寫一個 processor,然後讓你的所有的 consumer 類都使用這個 processor,這樣你可以在這個 consumer 中整出一大堆 if…else… 語句,相當的刺激。

當return和不return混雜在一起的時候,這份刺激中又多了些驚喜……

3.2大菜:「海鮮拼盤」

下面這個600行的方法讓我學會了「截長圖」

這是個switch-for-if-continue-return組合,很能理解「作者實在沒法把break和goto加進去」的苦衷。

——報告老師:“第四章我已經掌握了”

接下來見證遺蹟的時刻……

建議:多來來回回的讀讀這段代碼,有助於鍛鍊眼球靈活性,並且能有效抵抗頸椎病

看一遍,想一下,case 0的時候返回啥? 脖子有沒有舒服點兒?

四、程序/結構設計

認知升級

GrayService是個灰度服務,corpId是企業ID,那麼通過一次灰度放量,在腦殼裏執行一下程序,就可以完成認知升級。

CV工程師佳作

克隆和拷貝。爲了效率,你要學會使用 copy + past,你幾乎都不用理解別人的代碼,你就可以高效地編程了。

 

包裝,包裝,再包裝

把你所有的 API 都包裝上 6 到 8 遍,包裝深度多達 4層以上,以便找到足夠多相似的東西。

業務是否複雜,這不重要;重要的是1,2行代碼的封裝也是要的,不包個8層封裝,怎麼能說明理解分層了呢?

還好我一屏就可以看完整個鏈路

想必是個核心類

再多引用幾個類,我還能幹更多事!請大聲唱:我真的還想再包500類——《康熙王朝》。

羊大爲美

中國人喜歡大,都是“越大越好”,大房子,大車子;而現代中國人總把‘大”放在高位,把‘大”作爲對於一個事物最高的評價。像大人,大神,大聖,大仙,大中國,和別人介紹起自己的家鄉都會加上“大”字作前綴。所以,從古至今,大始終貫穿着人們對於美好事物的遐想。

我想說還有大類,大方法:

不要過早的return或continue,要「V型」

V型激起我寫代碼的慾望。

跟左邊的深V相比,右邊的就太差了,行數竟然變多了。

一張圖,一顆心,一場仗 + 一張網

一張網就是「碼網」。漁網是打魚的,碼網是打碼農。

上圖「包Cyclic」:Calculates the number of packages which each package directly or indirectly depends on, and which in turn directly or indirectly depend on it.

下圖「類Cyclic」:Calculates the number of classes or interfaces which each class directly or indirectly depends on, and which in turn directly or indirectly depend on it.

Note:Such cyclic dependencies may result in code which is difficult to understand and test.

翻譯:能看看,不能看拉倒

點擊立即免費試用雲產品 開啓雲上實踐之旅!

原文鏈接

本文爲阿里雲原創內容,未經允許不得轉載。

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