思考:如何寫(xiě)出讓同事難以維護(hù)的代碼?doge

導(dǎo)讀

本文從【程序命名&注釋】【數(shù)據(jù)類(lèi)型&類(lèi)&對(duì)象】【控制執(zhí)行流程】和【程序/結(jié)構(gòu)設(shè)計(jì)】四個(gè)方面梳理了一些真實(shí)案例，相信通過(guò)這些案例你能迅速get技能：如何寫(xiě)出讓同事難以維護(hù)的代碼doge。

摘要概覽

比起什么程序員刪庫(kù)跑路，我更喜歡「寫(xiě)出讓同事難以維護(hù)的代碼」，因?yàn)榧词共荒堋该骨Ч拧梗辽賄CS可以幫你「遺臭萬(wàn)年」。

?本文從【程序命名&注釋】【數(shù)據(jù)類(lèi)型&類(lèi)&對(duì)象】【控制執(zhí)行流程】和【程序/結(jié)構(gòu)設(shè)計(jì)】四個(gè)方面梳理了一些真實(shí)案例，相信通過(guò)這些案例你能迅速get技能：如何寫(xiě)出讓同事難以維護(hù)的代碼doge。? 說(shuō)回正題，前幾天在家附近的一個(gè)小學(xué)校旁邊散步，突然聽(tīng)到某個(gè)學(xué)生說(shuō)“上學(xué)期我是‘三好學(xué)生’，xxxx”。想了想，學(xué)生有“三好”，那么程序員“三好”是什么？ 我認(rèn)為程序員的“三好”是「好用」，「好看」，「好改」。這個(gè)是說(shuō)程序員的代碼：

• 要正確且健壯，就是好用；
• 要可讀性高，易于理解，就是好看；
• 要方便擴(kuò)展和改動(dòng)，就是好改；

平時(shí)不少文章都在聊“三好”的正例，今天理一些「好看」的反例，希望給讀者一些啟發(fā)和印象，避免編碼中的一些問(wèn)題，爭(zhēng)取做個(gè)“三好程序員”吧。

一、程序命名&注釋

1.1教你如何挑戰(zhàn)維護(hù)者

容易輸入的變量名

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

有創(chuàng)意地拼寫(xiě)錯(cuò)誤

比如：SetPintleOpening， SetPintalClosing，這樣可以讓人很難搜索代碼。 ?

使用縮寫(xiě)和拼音

比如：WTF，RTFSC …… （使用拼音縮寫(xiě)也同樣給力，比如：BT，TMD，TJJTDS）

論注釋的重要性：不然我以為是「駕校」是一類(lèi)重要客戶(hù)，要有單獨(dú)的helper

1.2嵌入式文檔之殤=注釋

不要盲目修改，注意理解！！！

注意理解，你會(huì)發(fā)現(xiàn)其中的不同點(diǎn)……

「注意理解」之后，意外出現(xiàn)了……

程序回憶錄

long~ long ago~【狼，狼，啊狗】??

千萬(wàn)注意something

實(shí)在不知道注意什么……

用注釋保留一些秘密

二、數(shù)據(jù)類(lèi)型&類(lèi)&對(duì)象

2.1教教你怎么用數(shù)組

無(wú)所不能的多維數(shù)組

如果你覺(jué)得二維、三維還不足夠，你可以試試四維。

仔細(xì)品一品，這個(gè)排版和換行可以教你快速數(shù)下標(biāo)的方法：行號(hào)-44，比如“常駐工作城市”的下標(biāo)就是25 ?。

想清楚下標(biāo)了再調(diào)用

一切皆對(duì)象，數(shù)組也是對(duì)象，用就是了

2.2對(duì)象？"類(lèi)"覺(jué)不愛(ài)

員工服務(wù)的四胞胎：倆哥哥service，倆妹妹helper；

——「木蘭辭」："四"兔傍地走，安能辨我是雌雄雄雌；

??

三、控制執(zhí)行流程

3.1開(kāi)胃菜：if-else

巨大的processor。寫(xiě)一個(gè) processor，然后讓你的所有的 consumer 類(lèi)都使用這個(gè) processor，這樣你可以在這個(gè) consumer 中整出一大堆 if…else… 語(yǔ)句，相當(dāng)?shù)拇碳ぁ?/span>

?

當(dāng)return和不return混雜在一起的時(shí)候，這份刺激中又多了些驚喜……

?

3.2大菜：「海鮮拼盤(pán)」

下面這個(gè)600行的方法讓我學(xué)會(huì)了「截長(zhǎng)圖」

??這是個(gè)switch-for-if-continue-return組合，很能理解「作者實(shí)在沒(méi)法把break和goto加進(jìn)去」的苦衷。

——報(bào)告老師：“第四章我已經(jīng)掌握了”

接下來(lái)見(jiàn)證遺跡的時(shí)刻……

建議：多來(lái)來(lái)回回的讀讀這段代碼，有助于鍛煉眼球靈活性，并且能有效抵抗頸椎病

看一遍，想一下，case 0的時(shí)候返回啥？??脖子有沒(méi)有舒服點(diǎn)兒？

四、程序/結(jié)構(gòu)設(shè)計(jì)

認(rèn)知升級(jí)

GrayService是個(gè)灰度服務(wù)，corpId是企業(yè)ID，那么通過(guò)一次灰度放量，在腦殼里執(zhí)行一下程序，就可以完成認(rèn)知升級(jí)。

CV工程師佳作

克隆和拷貝。為了效率，你要學(xué)會(huì)使用 copy + past，你幾乎都不用理解別人的代碼，你就可以高效地編程了。

? ?

包裝，包裝，再包裝

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

業(yè)務(wù)是否復(fù)雜，這不重要；重要的是1，2行代碼的封裝也是要的，不包個(gè)8層封裝，怎么能說(shuō)明理解分層了呢？

還好我一屏就可以看完整個(gè)鏈路??

?

想必是個(gè)核心類(lèi)

再多引用幾個(gè)類(lèi)，我還能干更多事！請(qǐng)大聲唱：我真的還想再包500類(lèi)——《康熙王朝》 ?。

?

羊大為美

中國(guó)人喜歡大，都是“越大越好”，大房子，大車(chē)子；而現(xiàn)代中國(guó)人總把‘大”放在高位，把‘大”作為對(duì)于一個(gè)事物最高的評(píng)價(jià)。像大人，大神，大圣，大仙，大中國(guó)，和別人介紹起自己的家鄉(xiāng)都會(huì)加上“大”字作前綴。所以，從古至今，大始終貫穿著人們對(duì)于美好事物的遐想。

我想說(shuō)還有大類(lèi)，大方法：

不要過(guò)早的return或continue，要「V型」

V型激起我寫(xiě)代碼的欲望。

跟左邊的深V相比，右邊的就太差了，行數(shù)竟然變多了。

一張圖，一顆心，一場(chǎng)仗 + 一張網(wǎng)

一張網(wǎng)就是「碼網(wǎng)」。漁網(wǎng)是打魚(yú)的，碼網(wǎng)是打碼農(nóng)。

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

下圖「類(lèi)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.

翻譯：能看看，不能看拉倒