一区二区三区三上|欧美在线视频五区|国产午夜无码在线观看视频|亚洲国产裸体网站|无码成年人影视|亚洲AV亚洲AV|成人开心激情五月|欧美性爱内射视频|超碰人人干人人上|一区二区无码三区亚洲人区久久精品

0
  • 聊天消息
  • 系統(tǒng)消息
  • 評論與回復(fù)
登錄后你可以
  • 下載海量資料
  • 學(xué)習在線課程
  • 觀看技術(shù)視頻
  • 寫文章/發(fā)帖/加入社區(qū)
會員中心
創(chuàng)作中心

完善資料讓更多小伙伴認識你,還能領(lǐng)取20積分哦,立即完善>

3天內(nèi)不再提示

降低代碼可讀性,增加維護難度的12個編碼“技巧”

jf_ro2CN3Fa ? 來源:稀土掘金 ? 2023-11-27 11:44 ? 次閱讀
加入交流群
微信小助手二維碼

掃碼添加小助手

加入工程師交流群

下面細數(shù)一下 降低代碼可讀性,增加維護難度的 12 個編碼“技巧”。

假設(shè)一個叫”二狗“ 的程序員,喜歡做以下事情。

1 二狗積極拆分微服務(wù),一個表對應(yīng)一個微服務(wù)

二狗十分認可微服務(wù)的設(shè)計思想。認為微服務(wù)可以獨立開發(fā)和發(fā)布,每次改動不會影響其他系統(tǒng)。大大提高了開發(fā)人員的效率和線上穩(wěn)定性。還可以在新服務(wù)里使用新的技術(shù),例如JDK 21

于是狗哥把微服務(wù)的思想發(fā)揮到極致,每一張表都是一個服務(wù)。系統(tǒng)的應(yīng)用架構(gòu)圖十分壯觀。狗哥自豪的跟新同學(xué)講解自己設(shè)計的系統(tǒng)。新同學(xué)看著十幾個服務(wù)陷入了思考,不停地問著每個服務(wù)的作用,干了什么。狗哥很滿足。

新同學(xué)第一次開發(fā)需求,表現(xiàn)很差。雖然他要改10個服務(wù),但是每個服務(wù)只改動了一點點。并且由于服務(wù)之間都是Rpc調(diào)用,需要定義大量的接口,他需要發(fā)布好多的 jar,定義版本號,解決測試環(huán)境版本沖突,測試和上線階段可把他忙壞了。

光是梳理上線順序,新同學(xué)就請教了狗哥 三次。最后還是狗哥幫他上線了3 個服務(wù),新同學(xué)才趕在 凌晨 3 點前把所有的服務(wù)發(fā)完??粗峦瑢W(xué)買了奶茶的份上,狗哥這次才沒有和領(lǐng)導(dǎo)吐槽,“這個同學(xué)不行啊,上個線都這么費勁”

微服務(wù)過多,也困擾著狗哥。雖然線上流量不高,但是由于 “微服務(wù)太多,系統(tǒng)架構(gòu)復(fù)雜",接口性能不行。

于是狗哥開始進行重構(gòu),他重新加了一個開關(guān),新邏輯可以減少Rpc,調(diào)用提高性能。狗哥在代碼中加了注釋 "新邏輯"。

狗哥把代碼上線了,但是在線上環(huán)境不敢放開,只在測試環(huán)境打開了開關(guān)。

2 二狗積極重構(gòu)代碼,但是線上不放量

狗哥喜歡對代碼進行重構(gòu),狗哥和領(lǐng)導(dǎo)吹牛,說“ 重構(gòu)后的代碼性能更強,更穩(wěn)定”。狗哥還添加了注釋 ”這是新邏輯 “。

但是狗哥在線上比較謹慎,并沒有進行放量。只是在測試環(huán)境,放開了全量。

新接手的同學(xué)不知道線上還沒放量,看到“這是新邏輯” ,他就在狗哥的“新邏輯”上改代碼。測試環(huán)境驗證一切正常,到了線上階段卻怎么也跑不通。

此時新同學(xué)才發(fā)現(xiàn) ”新邏輯“ 的開關(guān)沒有打開,你猜,他敢打開這個開關(guān)嗎?于是他只能刪代碼,在舊邏輯上重新開發(fā)。等到改完代碼,再上線時,已經(jīng)天亮了。

由于這次上線問題,大家一起熬夜加班,需求上線被推遲。新同學(xué)被產(chǎn)品和測試一頓騎臉輸出。新同學(xué)委屈的想要離職。

3 二狗喜歡挑戰(zhàn)自我,方法長度一定要超過1000行

二狗寫代碼天馬行空。二狗認為提煉新方法會打斷自己的編碼思路,代碼越長,邏輯越連貫,可讀性越高。二狗還認為 優(yōu)秀的程序員寫的方法都是 非常長的。這能體現(xiàn)個人的能力。

二狗不光自己寫超長的方法,在改別人的代碼時,也從不提煉新的方法。二狗總是在原來的方法中添加更長的一段代碼。

新同學(xué)接手代碼時速度很慢,即使加班到凌晨,也不理解狗哥代碼設(shè)計的藝術(shù)。狗哥還向領(lǐng)導(dǎo)抱怨,”你最近招的人不行啊,一個小需求開發(fā)這么久,上線還出了bug?!?/p>

4 二狗喜歡挑戰(zhàn)自我,一個方法 if/try/else 要嵌套10層以上

二狗寫代碼十分認真,想到哪里就寫哪里。if/else/try catch 層層嵌套。狗哥的思路很快,并且思考全面, 嵌套十幾層的代碼一點bug都沒有,測試同學(xué)都夸贊狗哥 ”代碼質(zhì)量真高啊 “,一個bug都沒有。

新同學(xué)接手新代碼時,看到嵌套十幾層的代碼,大腦瞬間就要爆炸。想要罵人,但是看到代碼作者是狗哥……

無奈之下,自己實在看不懂這段代碼,于是點了一杯奶茶,走到了狗哥工位旁,”狗哥,多喝點水,給你點了一杯奶茶?!@段代碼能給我講講嗎?“

狗哥過幾天和領(lǐng)導(dǎo)閑聊天,“新來的同學(xué)人不錯,還給我點奶茶喝”

5 二狗認為變量命名是藝術(shù),要隨機命名,不要和業(yè)務(wù)邏輯有關(guān)系

二狗覺得寫代碼是藝術(shù),就好像畫畫一樣?!蹦阋娺^幾個人能看懂 梵高的畫?” 狗哥曾經(jīng)和旁邊人吹牛。

二狗寫代碼思路十分奇特,有時候來不及想變量如何命名,有時候是懶得想變量命名。狗哥經(jīng)常隨便就命名了,例如 str1,str2,list1,list2等等。不得不說,狗哥的思維還是敏捷的,這么多變量命名都能記住,還不出bug。

但是狗哥記性不大行,過一兩個月就不太記得這些變量的意義了。

6 二狗積極寫注釋,但是寫了錯誤的注釋

一個成熟穩(wěn)重的程序員改別人代碼時會十分慎重,如果有代碼注釋,他們一定會十分認真閱讀并嘗試理解它。

二狗喜歡把注釋引入錯誤的方向,例如 “是” 改成 “不是”,“更好”改成”更差“,把兩處不相干的注釋交換一下位置 等。

新接手的同學(xué)點了一杯奶茶,虛心求助二狗,“狗哥,你寫的這段注釋有什么深意啊,我看了三天,也不理解啊”。

到時候狗哥就可以給新同學(xué)一邊裝B,一邊講代碼了。當然還要看心情,要是不口渴,可以講講。

7 二狗改代碼很認真,但是注釋從來不改

二狗改代碼真的非常認真,但是他不喜歡改注釋。最終代碼大改特改,注釋紋絲不動。最終代碼和注釋不相干,部分正確,部分錯誤。

新接手的同學(xué)研究了兩天也沒搞明白。于是求助了狗哥

到時候狗哥就可以大展神威了 ?!蹦嵌巫⑨屖清e的,你別管,就當沒有!“

狗哥順便還說了一句,”優(yōu)秀的代碼不需要寫注釋,也不知道是哪個XX 寫的注釋“,成功收割新同學(xué)的"欽佩"之情。

8 二狗喜歡復(fù)制代碼

狗哥寫代碼十分著急,根本來不及重構(gòu)。他總是想到一段代碼,就復(fù)制過來。神奇的是,狗哥經(jīng)常這么寫,但是也沒出什么問題。

但新同學(xué)就慘了,在改完狗哥的代碼后,總被測試同學(xué)背地里吐槽,“一點小需求咋這么多bug,跟狗哥比差遠了”。原來新同學(xué)改了一處,忘了改另外幾處,代碼被復(fù)制了好多遍,他實在無法全面梳理。

于是每次代碼寫完,新同學(xué)都要不停的研究代碼,總是害怕自己少改了哪些地方,下班時間越來越晚。并且新同學(xué)也不敢把雷同的代碼重構(gòu)到一起。(“你們猜猜他為什么不敢?)

慢慢的,組里的人都被迫向狗哥學(xué)習,狗哥成功輸出了自己的編碼習慣。

9 二狗積極寫技術(shù)方案,但是最終代碼實現(xiàn)不按照技術(shù)方案來

二狗非常喜歡寫技術(shù)方案,大部分時間都花在技術(shù)方案上,總是把技術(shù)方案打磨的 滑不留手。但是在寫代碼時,狗哥總覺得按照方案設(shè)計寫代碼,時間上根本來不及啊,還是簡單來吧,湊活實現(xiàn)吧。

例如狗哥曾經(jīng)設(shè)計了一套復(fù)雜的Redis秒殺庫存系統(tǒng),但是實現(xiàn)時選擇了最Low的 數(shù)據(jù)庫同步扣減方案。

狗哥寫的流程圖和實際代碼也沒什么關(guān)系。但是流程圖旁邊加滿了注釋和說明,讓人覺得 ”這個技術(shù)方案很權(quán)威“。

新同學(xué)熟悉項目時,從公司文檔中搜到了很多技術(shù)方案,本以為可以很快熟悉系統(tǒng),但是發(fā)現(xiàn)技術(shù)方案和代碼不太一樣。越看越迷惑。

于是點了奶茶再次走向了狗哥,狗哥告訴他,“那個技術(shù)方案太復(fù)雜,排期緊張,開發(fā)來不及。你就當沒那個技術(shù)方案?!?/p>

10 二狗十分自信,從不打日志。

二狗對自己的代碼十分自信,認為不會出現(xiàn)任何問題,所以他從來不打日志。每次開發(fā)代碼時,狗哥的思維天馬行空,但是從來不想加個日志會有助于排查問題。

直到有一天,線上真的出問題了,除了異常堆棧,找不到其他有效的日志。大家面面相覷,不知道怎么辦。狗哥挺身而出,重新加了日志,上線。故障持續(xù)了不知道有多久……,看著狗哥忙碌,領(lǐng)導(dǎo)不停地詢問還需要多久才能上線。

復(fù)盤會上,有人對狗哥不寫日志的行為進行批判,狗哥卻在 狡辯 “加了日志,就能避免這次故障嗎?出問題還不是因為你們系統(tǒng)出了bug,跟我不打日志有啥關(guān)系。” 雙方陷入了無限的扯皮之中……

11 二狗積極學(xué)習,引用一個高大上的框架 解決一個小問題

二狗非常喜歡學(xué)習,學(xué)習了很多高大上的框架。最近二狗學(xué)習了規(guī)則引擎,覺得這是個好東西,恰好最近在進行重構(gòu)。于是二狗把 drools、avatior、SPEL等規(guī)則引擎、表達式求值 等框架引入系統(tǒng)。只是為了解決策略模式的問題。即何種條件下使用哪種策略。狗哥在系統(tǒng)架構(gòu)圖里,著重講了規(guī)則引擎部分,十分自豪。

新同學(xué)熟悉系統(tǒng)后,光是規(guī)則引擎部分就看了足足一周。但是還是不知道怎么修改代碼。于是向狗哥請教。狗哥告訴他說," 你在這個地方 加一行代碼 rule.type == 12 ,走這個 CommonStrategy 策略類就可以了?!?/p>

新同學(xué)恍然大悟,原來這就是規(guī)則引擎啊。但是為什么不用策略模式呢?好像策略模式不費事??!狗哥技術(shù)就是強啊,殺雞用核彈。

12 二狗積極造輪子,能造輪子的程序員才是牛掰的程序員

二狗非常喜歡造輪子,他對開源軟件的大神們心向往之,覺得自己應(yīng)該向他們學(xué)習。狗哥認為 造輪子才能更快地成長。

于是在狗哥的積極學(xué)習下,組里的 分布式鎖 沒有使用 redission,而是自己用setnx搞的。雖然后面出了問題,但是狗哥的技術(shù)得到了鍛煉。

總結(jié)

降低代碼可讀性的方式方法 包括但不限于以上12種;

像二狗這樣的程序員包括但不限于二狗。






審核編輯:劉清

聲明:本文內(nèi)容及配圖由入駐作者撰寫或者入駐合作網(wǎng)站授權(quán)轉(zhuǎn)載。文章觀點僅代表作者本人,不代表電子發(fā)燒友網(wǎng)立場。文章及其配圖僅供工程師學(xué)習之用,如有內(nèi)容侵權(quán)或者其他違規(guī)問題,請聯(lián)系本站處理。 舉報投訴
  • 編碼器
    +關(guān)注

    關(guān)注

    45

    文章

    3808

    瀏覽量

    138072
  • RPC
    RPC
    +關(guān)注

    關(guān)注

    0

    文章

    111

    瀏覽量

    11887
  • SPEL
    +關(guān)注

    關(guān)注

    0

    文章

    3

    瀏覽量

    6181

原文標題:降低代碼可讀性,增加維護難度的 12 個編碼“小技巧”,地位穩(wěn)了!

文章出處:【微信號:芋道源碼,微信公眾號:芋道源碼】歡迎添加關(guān)注!文章轉(zhuǎn)載請注明出處。

收藏 人收藏
加入交流群
微信小助手二維碼

掃碼添加小助手

加入工程師交流群

    評論

    相關(guān)推薦
    熱點推薦

    Google軟件工程中主要的過程部分

    代碼風格指南只能解決一些很基本的可讀性問題,如代碼縮進、函數(shù)命名風格、代碼行數(shù)限制等。但代碼可讀性
    的頭像 發(fā)表于 09-23 11:50 ?1217次閱讀

    《圖解運算放大器電路》輔以大量插圖,有較強的可讀性...

    集成運算放大器構(gòu)成的電路實例以及集成運算放大器的電路構(gòu)成與原理及使用時的注意事項等。《運算放大器電路》內(nèi)容簡潔、重點突出、實用強,輔以大量插圖,有較強的可讀性及參考。   《運算放大器電路》既可供工科院校相關(guān)專業(yè)師生參考,亦
    發(fā)表于 08-10 10:05

    吐槽這本書的代碼實在晦澀難懂,代碼風格的可讀性也較差

    `不得不吐槽一下,這本書的代碼實在晦澀難懂,代碼風格的可讀性也較差`
    發(fā)表于 03-02 23:42

    Verilog HDL代碼書寫規(guī)范

    1. 目的本規(guī)范的目的是提高書寫代碼可讀性、可修改性、可重用,優(yōu)化代碼綜合和仿真的結(jié)果,指導(dǎo)設(shè)計工程師使用VerilogHDL規(guī)范代碼
    發(fā)表于 12-08 14:36

    注釋那些事兒:前端代碼質(zhì)量系列文章(一)

    (包括我們自己,也可能包括機器,如 jsdoc)看,幫助讀者閱讀理解代碼并進行維護?!溉鐭o必要,勿增注釋」是指注釋要避免過多過濫,不要為了注釋而注釋。多余的注釋等價于冗余的代碼,除了對增加
    發(fā)表于 04-27 16:21

    優(yōu)先提高代碼可讀性的必要

    什么阻礙了開發(fā)者閱讀代碼 好吧,我們一致認為,我們應(yīng)該讓代碼更易于閱讀,這樣可以節(jié)約時間和金錢,對吧?但這究竟意味著什么? 有跡象表明,下面兩基本方面極大地降低了開發(fā)者閱讀
    發(fā)表于 09-26 14:55 ?0次下載

    你了解Linux平臺相關(guān)代碼的C++解決方案

    由于程序中不可避免的存在平臺相關(guān)代碼(系統(tǒng)調(diào)用等),軟件研發(fā)人員為了保證自己的產(chǎn)品在各個 Linux 平臺上運行順暢,一般都需要在源代碼中大量使用預(yù)編譯參數(shù),這樣會大大降低程序的可讀性
    發(fā)表于 05-16 14:47 ?474次閱讀
    你了解Linux平臺相關(guān)<b class='flag-5'>代碼</b>的C++解決方案

    嵌入式代碼之編寫規(guī)范

    嵌入式代碼編碼規(guī)范,用于規(guī)范自己的代碼,增強可讀性,非標準規(guī)范。最好能強制自己形成良好的編碼風格,有利于開發(fā)
    的頭像 發(fā)表于 04-26 15:21 ?5641次閱讀

    如何編寫可讀性代碼

    編寫可讀性代碼作者:極鏈科技 湯紅燕什么叫可讀性代碼?簡單來說,就是易于理解、耗腦時間少、可維護性較高的
    的頭像 發(fā)表于 08-16 18:13 ?1493次閱讀
    如何編寫<b class='flag-5'>可讀性</b><b class='flag-5'>代碼</b>

    科普一下Verilog代碼命名規(guī)范

    命名規(guī)范包括模塊命名規(guī)范和代碼命名規(guī)范,代碼命名需要有確定的含義,提高代碼可讀性和可維護性
    的頭像 發(fā)表于 11-17 09:54 ?4378次閱讀

    如何寫出易維護的嵌入式代碼怎么寫?

    面向?qū)ο蟮恼Z言更接近人的思維方式,而且在很大程度上降低代碼的復(fù)雜,同時提高了代碼可讀性和可維護性
    發(fā)表于 08-23 09:42 ?372次閱讀
    如何寫出易<b class='flag-5'>維護</b>的嵌入式<b class='flag-5'>代碼</b>怎么寫?

    python如何換行而不運行代碼

    Python程序中的換行是指在代碼中使用特定的語法來表示換行,以使代碼更易讀。換行的目的是為了讓程序更具可讀性并提高代碼的可維護性。然而,換
    的頭像 發(fā)表于 11-24 09:50 ?3756次閱讀

    如何提升嵌入式C語言代碼可讀性

    接口是面向?qū)ο笳Z言中的一比較重要的概念,接口只對外部承諾實現(xiàn)該接口的實體可以完成什么樣的功能,但是不暴露實現(xiàn)的方式。這樣的好處是,實現(xiàn)者可以在不接觸接口使用者的代碼的情況下,對實現(xiàn)進行調(diào)整。
    發(fā)表于 04-11 11:30 ?504次閱讀
    如何提升嵌入式C語言<b class='flag-5'>代碼</b><b class='flag-5'>可讀性</b>

    C語言編碼規(guī)范,這才是最理想的!

    編碼規(guī)范,沒有最好,只有最合適,有但不執(zhí)行不如沒有。一、編碼原則01可讀性清晰第一清晰是易于維護程序必須具備的特征。
    的頭像 發(fā)表于 07-06 08:11 ?1624次閱讀
    C語言<b class='flag-5'>編碼</b>規(guī)范,這才是最理想的!

    深入淺出系列之代碼可讀性

    ”,這是對我最大的鼓勵。 一、老生常談,到底啥是可讀性 一句話:見名知其義。有人說好的代碼必然有清晰完整的注釋,我不否認;也有人說代碼即注釋,是代碼簡潔之道的最高境界,我也不否認。但我
    的頭像 發(fā)表于 08-09 16:00 ?528次閱讀