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

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

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

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

為什么要寫糟糕的代碼?什么是整潔的代碼?

汽車ECU開發(fā) ? 來源:稀土掘金 ? 作者:unebrise ? 2022-11-21 10:58 ? 次閱讀
加入交流群
微信小助手二維碼

掃碼添加小助手

加入工程師交流群

寫在前面

這個(gè)文章本來沒打算寫,直到經(jīng)歷了幾次代碼評審會(huì)議之后,我意識(shí)到自己編碼方式還不成系統(tǒng),仍然需要進(jìn)行系統(tǒng)化的學(xué)習(xí),掌握前輩們總結(jié)出的最適用的規(guī)律無疑是一種好的方式。恰好很早之前就收藏了這本代碼整潔之道,便決定趁著閑暇之際閱讀總結(jié)一下,如果想系統(tǒng)學(xué)習(xí)的話建議還是讀書,本文檔只是作為自己的記錄用。

一個(gè)人的職業(yè)素養(yǎng)體現(xiàn)在解決問題的方式、步驟以及反思的程度,而不在于這個(gè)問題本身的難度。思考一個(gè)問題:一個(gè)技術(shù)人員要具備哪些素質(zhì)可以被認(rèn)為是專業(yè)人員呢?如果還不具備需要如何改變才能被視為專業(yè)人士呢?

整潔代碼

一、為什么要寫糟糕的代碼?

每個(gè)人都有自己的原因,相信很多人都會(huì)想著等有時(shí)間的話再進(jìn)行代碼優(yōu)化,但是要記住一句話:稍后等于永不。

二、混亂代碼的代價(jià)?

后續(xù)難以維護(hù)和修改,生產(chǎn)力和時(shí)間呈現(xiàn)負(fù)相關(guān)。

三、什么是整潔的代碼?

整潔的代碼只做好一件事:每個(gè)類、每個(gè)函數(shù)、每個(gè)模塊都專注于一事,完全不受四周細(xì)節(jié)的干擾和污染。

更全面的概括是:減少重復(fù)代碼、提高表達(dá)力、提早構(gòu)建簡單抽象。

更具體的實(shí)現(xiàn):請接著往下看吧!

更好的變量命名

一、見名知意

二、抽象工廠:接口不要命名為IShapeFactory,前導(dǎo)字母對于用戶來說其實(shí)是干擾,用戶只需要知道那是個(gè)抽象工廠,建議使用CShapeFactory或許體驗(yàn)更好

三、類名要用名詞,方法要用動(dòng)詞,詞性相近的get、fetch這種詞不應(yīng)出現(xiàn)在一起,可以添加后綴getNumber、fetchData實(shí)現(xiàn)相同的效果

四、別害怕長名字:使用描述性的名稱,哪怕比較長也比短而令人費(fèi)解的名稱好

更好的函數(shù)

一、函數(shù)的結(jié)構(gòu)本質(zhì)上要短小、再短小,以不容納if/else if/else嵌套結(jié)構(gòu)為目標(biāo)

二、只做一件事:正如前面所說,函數(shù)只做好一件事就足夠了,標(biāo)志就是“看是否還能拆出一個(gè)函數(shù),該函數(shù)不僅只是單純地重新詮釋其實(shí)現(xiàn)”

三、每個(gè)函數(shù)一個(gè)抽象層級:代碼一般是“自頂向下”的閱讀順序,每個(gè)函數(shù)后面跟著的應(yīng)該是下一抽象層級的函數(shù)

[抽象層級:getHtml函數(shù)位于較高抽象層,pagePathName = pathParser.render(pagePath)位于中間抽象層,.append(" ")則位于較低抽象層]

四、switch語句:天生就需要做N件事,但是可以將其放置在較低抽象層級,但是當(dāng)出現(xiàn)新的類型時(shí)會(huì)違反“單一權(quán)責(zé)原則、開放閉合原則”,此時(shí)最好創(chuàng)建多態(tài)對象

//原文中:對于每個(gè)case分支進(jìn)行單獨(dú)處理,添加新類型不必修改原來的代碼增加新的處理類即可
functiongetName(name){
switch(name){
case'ming':
returnnewClassMing(name);
case'hu':
returnnewClassHu(name);
case'uzi':
returnnewClassUzi(name);
default:
thrownewClassCommon(name);
}
}

//我更喜歡用另一種方法:修改只需要在對象里修改即可,且提高了函數(shù)的簡潔性
constnameCollectionUtils={
 ming:newClassMing('ming');
hu:newClassHu('hu');
uzi:newClassUzi('uzi');
}
functiongetName(name){
returnnameCollectionUtils.hasOwn(name)?nameCollectionUtils[name]:newClassCommon(name)
}

五、函數(shù)參數(shù)最多不多于兩個(gè):包括輸入?yún)?shù)和輸出參數(shù)

六、無副作用:函數(shù)內(nèi)部不要做出未能預(yù)期的改動(dòng),不要對外部產(chǎn)生影響

七、使用異常替代返回錯(cuò)誤碼:使用try...catch替代多層級的if嵌套,永遠(yuǎn)走在主路上,不要過多考慮邊界,這樣可以讓你一直保持思維連貫

八、錯(cuò)誤處理單獨(dú)抽出:這一條我認(rèn)為可以視情況而定,畢竟抽出僅僅是為了美觀

九、別重復(fù):多個(gè)函數(shù)使用的相同邏輯的代碼一定要抽出,可以參考面向?qū)ο蟮幕?,前端開發(fā)中的面向組件編程、面向模塊編程也是這種思想

注釋&格式

每個(gè)人有每個(gè)人的習(xí)慣,采取一些通用準(zhǔn)則即可,畢竟如何太過離譜在公司是會(huì)挨打的~

錯(cuò)誤處理

也沒有什么固定的章程,最好采取try...catch優(yōu)先的原則

邊界

總結(jié)而言,使用自己可以控制的代碼

單元測試

現(xiàn)在的互聯(lián)網(wǎng)企業(yè)絕大多數(shù)都是敏捷式開發(fā),很少有能遵守測試驅(qū)動(dòng)原則的公司,而且為了保證進(jìn)度很少會(huì)有技術(shù)團(tuán)隊(duì)會(huì)去要求單元測試,所以這一條仁者見仁吧,個(gè)人認(rèn)為這一項(xiàng)的實(shí)際實(shí)現(xiàn)只能是一個(gè)比較美好的愿景。

一、類的組織:按照下面的順序,不要暴露出內(nèi)部屬性,利用方法達(dá)到同樣的目的

classDemoOrganization{
staticsname='sname'
privatepname='pname'
private_pname='_pname'
protectedtname='tname'

publicgetPublicName(){
returnthis.pname
}
private_getPrivateName(){
returnthis._pname
}
}

二、單一權(quán)責(zé)原則(SPR):類或模塊應(yīng)有且只有一條加以修改的理由,實(shí)現(xiàn)了這個(gè)原則的類更易得到復(fù)用

三、保持內(nèi)聚性:類中定義的變量應(yīng)被盡可能多的方法使用到,如果不能滿足的話就把使用到變量的函數(shù)拆分成小類

四、開放封閉原則(OCP):類應(yīng)當(dāng)對擴(kuò)展開放,對修改封閉,通過子類化手段可以實(shí)現(xiàn)新功能的添加的同時(shí)不觸及其他類

五、依賴倒置原則(DIP):類應(yīng)當(dāng)依賴于抽象而不是依賴于具體細(xì)節(jié)

六、解耦:不同方法和模塊間不要互相產(chǎn)生影響,即“分而治之”、“化整為零”

系統(tǒng)

一、構(gòu)造和使用分開:構(gòu)造的細(xì)節(jié)應(yīng)隔離與應(yīng)用程序代碼之外,使用者只能獲取構(gòu)造者想讓使用者獲得的東西

二、設(shè)計(jì)時(shí)要能滿足從簡單到復(fù)雜的更新迭代

迭進(jìn)

總結(jié)上述,只要遵守以下原則,就可以得到一個(gè)具有良好設(shè)計(jì)的可迭進(jìn)的程序:

運(yùn)行所有測試

不可重復(fù)

表達(dá)了程序員的意圖

盡可能減少類和方法的數(shù)量

以上規(guī)則按重要程度排列

并發(fā)編程

首先要了解“線程”這個(gè)概念:CPU調(diào)度的最小單位,區(qū)別于“進(jìn)程”是資源分配的最小單位。區(qū)別見下方表格:

分類 數(shù)據(jù)共享 消耗資源 是否影響兄弟程序 最大可擴(kuò)展維度 是否有鎖
進(jìn)程 多機(jī)
線程 簡單 可能影響所在進(jìn)程 多核

如果說對象是過程的抽象,那么線程是調(diào)度的抽象

前端使用的js語言是瀏覽器腳本語言,最主要的用途是和用戶互動(dòng)和操作DOM,這決定了js只能是單線程否則會(huì)產(chǎn)生復(fù)雜的同步問題,但是js仍然可以模擬并發(fā)執(zhí)行,具體實(shí)現(xiàn)自行查詢相關(guān)資料

當(dāng)前還沒學(xué)習(xí)到并發(fā)編程的語言,以后碰到再補(bǔ)充學(xué)習(xí)

重構(gòu)

這個(gè)模塊我認(rèn)為是最重要的模塊,甚至比怎么去編寫新的程序更重要,因?yàn)橐粋€(gè)公司的沉積項(xiàng)目的數(shù)量是巨大的,很可能會(huì)對其中幾個(gè)甚至更多進(jìn)行重構(gòu)(還是因?yàn)橹按a寫的太爛無法維護(hù)),所以重構(gòu)中需要注意的點(diǎn)也要有一個(gè)清晰的認(rèn)知。

只需要遵守一條原則:簽入的代碼比簽出的更整潔。

寫在最后

以上是我從前端角度總結(jié)的從這本書中得到的一些收獲,但是每個(gè)人都會(huì)有每個(gè)人自己的理解,所以還是推薦自己去讀一遍這本書,不需要多精細(xì)只要熟悉一下這些概念提出來的場景,相信會(huì)有更大的收獲。






審核編輯:劉清

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

    關(guān)注

    0

    文章

    20

    瀏覽量

    11635
  • DIP
    DIP
    +關(guān)注

    關(guān)注

    0

    文章

    248

    瀏覽量

    31038
  • OCP
    OCP
    +關(guān)注

    關(guān)注

    0

    文章

    80

    瀏覽量

    16784
  • DOM
    DOM
    +關(guān)注

    關(guān)注

    0

    文章

    18

    瀏覽量

    9726

原文標(biāo)題:常說的代碼整潔到底是什么?

文章出處:【微信號:eng2mot,微信公眾號:汽車ECU開發(fā)】歡迎添加關(guān)注!文章轉(zhuǎn)載請注明出處。

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

掃碼添加小助手

加入工程師交流群

    評論

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

    OLED代碼分享

    OLED代碼
    發(fā)表于 04-29 17:04 ?1次下載

    分析C語言代碼結(jié)構(gòu)的設(shè)計(jì)問題

    來分析一個(gè)C語言代碼結(jié)構(gòu)的設(shè)計(jì)問題。 這段代碼,使用了兩次malloc,分別給 p1 和 p2 申請了內(nèi)存。用完后,內(nèi)存釋放,防止內(nèi)存泄漏。 大家覺得,這樣的代碼設(shè)計(jì)有沒有問題。 代碼
    的頭像 發(fā)表于 02-11 09:31 ?366次閱讀

    代碼與傳統(tǒng)開發(fā)的區(qū)別 低代碼與無代碼開發(fā)的區(qū)別

    在軟件開發(fā)領(lǐng)域,傳統(tǒng)開發(fā)、低代碼開發(fā)以及無代碼開發(fā)是三種不同的開發(fā)方式,每種方式都有其獨(dú)特的優(yōu)勢和適用場景。 一、低代碼開發(fā)與傳統(tǒng)開發(fā)的區(qū)別 低代碼開發(fā)是一種新興的應(yīng)用程序開發(fā)方法,旨
    的頭像 發(fā)表于 01-31 10:48 ?614次閱讀

    代碼在敏捷開發(fā)中的應(yīng)用

    代碼平臺(tái)的定義 低代碼平臺(tái)提供了一個(gè)可視化的、拖放式的用戶界面,允許開發(fā)者通過圖形化的方式快速構(gòu)建應(yīng)用程序,而無需編寫大量的代碼。這些平臺(tái)通常包括預(yù)構(gòu)建的模板、組件和邏輯模塊,使得開發(fā)人員可以專注
    的頭像 發(fā)表于 01-07 09:58 ?448次閱讀

    SQL錯(cuò)誤代碼及解決方案

    在SQL數(shù)據(jù)庫開發(fā)和管理中,常見的錯(cuò)誤代碼及其解決方案可以歸納如下: 一、語法錯(cuò)誤(Syntax Errors) 錯(cuò)誤代碼 :無特定代碼,但通常會(huì)在錯(cuò)誤消息中明確指出是語法錯(cuò)誤。 原因 :SQL語句
    的頭像 發(fā)表于 11-19 10:21 ?6517次閱讀

    Gmapping源代碼

    Gmapping源代碼.docx
    發(fā)表于 11-16 13:42 ?0次下載

    如何自動(dòng)生成verilog代碼

    介紹幾種自動(dòng)生成verilog代碼的方法。
    的頭像 發(fā)表于 11-05 11:45 ?1028次閱讀
    如何自動(dòng)生成verilog<b class='flag-5'>代碼</b>

    昂洋科技談國巨貼片電阻的尺寸代碼和選購

    國巨貼片電阻是一種廣泛應(yīng)用于電子電路中的小型電阻,其尺寸代碼和選購要點(diǎn)對于確保電路性能和可靠性至關(guān)重要。以下是對國巨貼片電阻尺寸代碼和選購的詳細(xì)解答: 一、國巨貼片電阻的尺寸代碼 國巨貼片電阻的尺寸
    的頭像 發(fā)表于 11-01 15:21 ?651次閱讀
    昂洋科技談國巨貼片電阻的尺寸<b class='flag-5'>代碼</b>和選購

    MSP代碼保護(hù)功能

    電子發(fā)燒友網(wǎng)站提供《MSP代碼保護(hù)功能.pdf》資料免費(fèi)下載
    發(fā)表于 09-21 09:14 ?0次下載
    MSP<b class='flag-5'>代碼</b>保護(hù)功能

    代碼整潔之道-大師眼中的整潔代碼是什么樣

    模糊,帶著這個(gè)問題,本人讀完了世界軟件開發(fā)大師馬丁的《代碼整潔之道》這本書,來了解下大師眼中的整潔代碼畫像是什么樣的,相信能給你帶來不一樣的理解和感悟。 關(guān)于
    的頭像 發(fā)表于 09-09 16:30 ?648次閱讀
    <b class='flag-5'>代碼</b><b class='flag-5'>整潔</b>之道-大師眼中的<b class='flag-5'>整潔</b><b class='flag-5'>代碼</b>是什么樣

    java反編譯的代碼可以修改么

    Java反編譯是一種將編譯后的Java字節(jié)碼(.class文件)轉(zhuǎn)換回源代碼的過程。反編譯后的代碼可以進(jìn)行修改,但是需要注意,反編譯代碼的質(zhì)量和可讀性可能會(huì)受到原始編譯代碼的混淆、優(yōu)化
    的頭像 發(fā)表于 09-02 11:00 ?1271次閱讀

    ida反編譯出來代碼能直接用嗎

    IDA反編譯出來的代碼通常 不能直接使用 ,這主要基于以下幾個(gè)方面的原因: 一、代碼的不完整性 IDA反編譯生成的代碼可能缺少原始源代碼中的某些關(guān)鍵信息。在編譯過程中,編譯器會(huì)優(yōu)化
    的頭像 發(fā)表于 09-02 10:55 ?1435次閱讀

    軟件設(shè)計(jì)哲學(xué):新“代碼整潔之道”

    工作三年以來一直對寫出設(shè)計(jì)優(yōu)雅且可讀性較好的代碼抱有執(zhí)念,最初接觸到的關(guān)于代碼整潔和軟件設(shè)計(jì)的書是《代碼整潔之道》,這本書大概在我入職半年時(shí)
    的頭像 發(fā)表于 07-22 12:18 ?488次閱讀
    軟件設(shè)計(jì)哲學(xué):新“<b class='flag-5'>代碼</b><b class='flag-5'>整潔</b>之道”

    國內(nèi)低代碼平臺(tái)推薦--萬界星空科技低代碼平臺(tái)

    代碼平臺(tái)是一種應(yīng)用程序,它為編程提供圖形用戶界面,從而以極快的速度開發(fā)代碼,減少傳統(tǒng)編程工作。 這些工具有助于快速開發(fā)代碼,最大限度地減少手工編碼的工作量。這些平臺(tái)不僅有助于編碼,還有助于快速設(shè)置和部署。
    的頭像 發(fā)表于 07-18 15:39 ?567次閱讀
    國內(nèi)低<b class='flag-5'>代碼</b>平臺(tái)推薦--萬界星空科技低<b class='flag-5'>代碼</b>平臺(tái)