當(dāng)前位置:首頁(yè) > 公眾號(hào)精選 > 嵌入式微處理器
[導(dǎo)讀]在代碼中用一堆嵌套,花大量時(shí)間寫(xiě)出漂亮的代碼但最后才發(fā)現(xiàn)無(wú)法運(yùn)行,不給任務(wù)留緩沖時(shí)間…… 這是很多新手程序員都踩過(guò)的雷。在這篇文章中,一位全棧首席開(kāi)發(fā)者總結(jié)了高級(jí)開(kāi)發(fā)人員的19個(gè)編碼原則,可以幫助新手少踩些坑。

在代碼中用一堆嵌套,花大量時(shí)間寫(xiě)出漂亮的代碼但最后才發(fā)現(xiàn)無(wú)法運(yùn)行,不給任務(wù)留緩沖時(shí)間…… 這是很多新手程序員都踩過(guò)的雷。在這篇文章中,一位全棧首席開(kāi)發(fā)者總結(jié)了高級(jí)開(kāi)發(fā)人員的 19 個(gè)編碼原則,可以幫助新手少踩些坑。


進(jìn)行軟件開(kāi)發(fā),整天敲代碼、好不容易調(diào)試成功,但是代碼的質(zhì)量堪憂,可讀性不是很高,反過(guò)頭來(lái)還得對(duì)代碼進(jìn)行完善。
也許這不是你的編碼能力問(wèn)題,很有可能在你進(jìn)行代碼編寫(xiě)時(shí),一些看似不重要的編碼注意事項(xiàng)沒(méi)有遵守。 這有一份高級(jí)開(kāi)發(fā)人員經(jīng)常遵循的 19 條原則,其中很多與實(shí)際編碼無(wú)關(guān),而是與流程以及如何處理任務(wù)有關(guān),可能對(duì)你有幫助。


1. Rule Of Three 原則

這是一條代碼重構(gòu)的經(jīng)驗(yàn)法則,用于決定何時(shí)將復(fù)制的代碼段替換為新的代碼 / 過(guò)程 / 方法。

它的含義是,第一次用到某個(gè)功能時(shí),你寫(xiě)一個(gè)特定的解決方法;第二次又用到的時(shí)候,你拷貝上一次的代碼;第三次出現(xiàn)的時(shí)候,你要著手「抽象化」,寫(xiě)出通用的解決方法。

該原則的主要思想是使代碼 / 過(guò)程 / 方法更加通用,從而保證在其他地方可以重復(fù)使用。

2. 應(yīng)用程序結(jié)構(gòu)與編碼方式保持一致

應(yīng)用程序結(jié)構(gòu)與編碼方式保持一致有助于提高其可讀性和可維護(hù)性。

嘗試制定編碼標(biāo)準(zhǔn),這有助于保持編碼一致性。編碼標(biāo)準(zhǔn)應(yīng)該與變量的命名規(guī)則一樣少。另一大問(wèn)題是應(yīng)用程序的結(jié)構(gòu),開(kāi)發(fā)人員進(jìn)行更改或添加新內(nèi)容的地方應(yīng)該很明顯。

3. 減少程序嵌套

if 里面嵌套 if 會(huì)使得程序很混亂,代碼很難讀。在編寫(xiě)代碼時(shí)可能無(wú)法繞開(kāi)這些問(wèn)題,但你需要經(jīng)常查看代碼結(jié)構(gòu)。

else if 同樣如此,因此需要盡量避免嵌套。

一種有效的解決方法是衛(wèi)語(yǔ)句:衛(wèi)語(yǔ)句把復(fù)雜的條件表達(dá)式拆分成多個(gè)條件表達(dá)式。

不使用衛(wèi)語(yǔ)句的編碼方式:

if (account != null){ if (order != null) { if (order.term == Term.Annually) { // term annually } else if (order.term == Term.Monthly) { // term monthly } else { throw new InvalidEnumArgumentException(nameof(term)); } } else { throw new ArgumentNullException(nameof(subscription)); }}

使用衛(wèi)語(yǔ)句的編碼方式:

if (account == null){ throw new ArgumentNullException(nameof(account));}if (order == null){ throw new ArgumentNullException(nameof(order));}if (order.term == Term.Annually){ // term annually (return here)}if (order.term == Term.Monthly){ // term monthly (return here)}throw new InvalidEnumArgumentException(nameof(order.term));

4. 了解全局很重要

了解全局有助處理較小的細(xì)節(jié)。一旦了解了全局,你就不會(huì)花很長(zhǎng)的時(shí)間在小細(xì)節(jié)上。

5. 程序中的命名

在編程中進(jìn)行命名是最困難的事情之一,包括為一個(gè)類、一個(gè)方法命名,甚至是為變量命名。優(yōu)秀的開(kāi)發(fā)人員會(huì)花時(shí)間考慮相關(guān)的命名方式,這樣會(huì)增加程序的可讀性。

6. 減少技術(shù)負(fù)債

技術(shù)負(fù)債指開(kāi)發(fā)人員為了加速軟件開(kāi)發(fā),在應(yīng)該采用最佳方案時(shí)進(jìn)行了妥協(xié),改用了短期內(nèi)能加速軟件開(kāi)發(fā)的方案,從而在未來(lái)給自己帶來(lái)的額外開(kāi)發(fā)負(fù)擔(dān)。這種技術(shù)上的選擇就像一筆債務(wù)一樣,雖然眼前看起來(lái)可以得到好處,但必須在未來(lái)償還。軟件工程師必須付出額外的時(shí)間和精力持續(xù)修復(fù)之前的妥協(xié)所造成的問(wèn)題及副作用,或是進(jìn)行重構(gòu),把架構(gòu)改善為最佳實(shí)現(xiàn)方式。

對(duì)于技術(shù)負(fù)債問(wèn)題,提高預(yù)估時(shí)間有助于解決這類問(wèn)題。盡自己最大的努力寫(xiě)好代碼,否則你將不斷地進(jìn)行代碼完善。

7. 提高預(yù)估時(shí)間

你會(huì)看到,高級(jí)開(kāi)發(fā)人員總是給任務(wù)預(yù)留更多的時(shí)間,因?yàn)樗麄冎劳瓿扇蝿?wù)所需的時(shí)間總是高于預(yù)期,而且在評(píng)估階段增加一個(gè)緩沖時(shí)間可以真正幫助你把事情做好。

這確實(shí)有助于解決技術(shù)負(fù)債問(wèn)題。如果你低估了任務(wù)完成時(shí)間,你就可能會(huì)因?yàn)闀r(shí)間不夠而寫(xiě)出僅僅可以運(yùn)行的代碼,簡(jiǎn)潔性、可維護(hù)性就顧不上了。

8. 文檔和代碼注釋

文檔和代碼注釋有助于保存上下文和共享知識(shí)。你會(huì)聽(tīng)到有經(jīng)驗(yàn)的人一直在說(shuō),我們是否可以記錄這個(gè)過(guò)程,或者代碼審查失敗,因?yàn)閷?duì)接口之類的內(nèi)容沒(méi)有任何注釋。

9. 刪除不需要的代碼

許多缺乏自信的開(kāi)發(fā)人員會(huì)注釋掉大量的代碼塊,而不是選擇刪除。但是代碼版本控制是有目的的!優(yōu)秀的開(kāi)發(fā)人員會(huì)刪除應(yīng)用程序中不好的代碼。

10. 花時(shí)間進(jìn)行代碼評(píng)審

優(yōu)秀的開(kāi)發(fā)人員會(huì)花更多的時(shí)間在代碼評(píng)審上,代碼評(píng)審的重要性包括:

  • 更早地發(fā)現(xiàn)錯(cuò)誤;

  • 提高開(kāi)發(fā)人員的技能,并讓團(tuán)隊(duì)的其他成員參與到良好的實(shí)踐中;

  • 共享知識(shí);

  • 一致的設(shè)計(jì)和實(shí)現(xiàn)。


最好的代碼評(píng)審過(guò)程是:

對(duì)于一個(gè)風(fēng)險(xiǎn)較小的任務(wù),1 名開(kāi)發(fā)人員評(píng)審就可以;
中型 / 大型更改或者是有風(fēng)險(xiǎn)的更改,應(yīng)由 3 名開(kāi)發(fā)人員進(jìn)行評(píng)審,其中須有一位是高級(jí)開(kāi)發(fā)人員;
風(fēng)險(xiǎn)極高的更改或者是正在開(kāi)發(fā)的應(yīng)用程序的新部分,應(yīng)該安排一次會(huì)議,3 名開(kāi)發(fā)人員中至少有一位是首席開(kāi)發(fā)人員,他們一起完成每條線并提出觀點(diǎn)。

11. 編寫(xiě)好的測(cè)試

你會(huì)注意到經(jīng)驗(yàn)豐富、能力更強(qiáng)的開(kāi)發(fā)人員花更多的時(shí)間編寫(xiě)好的測(cè)試。擁有好的測(cè)試可以幫助你更有信心地?cái)U(kuò)展應(yīng)用程序,并減少錯(cuò)誤。

12. 花時(shí)間設(shè)計(jì)程序

在真正投入寫(xiě)代碼之前,開(kāi)發(fā)者會(huì)經(jīng)過(guò)一番思考并將代碼分解成小塊。這有助于他們更好地將所有內(nèi)容組合在一起并創(chuàng)建更清晰的代碼。

13. 關(guān)注基礎(chǔ)原理,而不是語(yǔ)法

更多地關(guān)注基礎(chǔ)原理,而不是語(yǔ)法,有助于開(kāi)發(fā)者更快地發(fā)現(xiàn)問(wèn)題,也能更好地理解問(wèn)題并在搜索引擎上搜索解決方案。

14. 讓搜索引擎成為你最好的朋友

高級(jí)開(kāi)發(fā)者都是用搜索引擎來(lái)解決問(wèn)題的專家。從上一條也可以看出,他們關(guān)注基礎(chǔ)原理而不是語(yǔ)法,因此知道要搜索的關(guān)鍵詞。如果你一直專注于語(yǔ)法,這將很難做到。

15. 首先確保程序能運(yùn)行,然后再完善

你經(jīng)常會(huì)看到一些相對(duì)較弱的開(kāi)發(fā)人員,他們一開(kāi)始花費(fèi)大量的時(shí)間讓程序看起來(lái)漂亮,但之后發(fā)現(xiàn),程序不能運(yùn)行。

優(yōu)秀的開(kāi)發(fā)人員會(huì)在更早的階段找到愉快的工作方式。在他們把事情做好之前,盡早發(fā)現(xiàn)問(wèn)題。這可以幫助項(xiàng)目進(jìn)行得更加順利。

16. 風(fēng)險(xiǎn)管理和問(wèn)題解決

高級(jí)開(kāi)發(fā)人員可以定義風(fēng)險(xiǎn),能夠通過(guò)應(yīng)用設(shè)計(jì)模式提煉出復(fù)雜的問(wèn)題,并且能夠根據(jù)以往的經(jīng)驗(yàn)獨(dú)立解決不同的問(wèn)題。

17. 多提問(wèn)

高級(jí)開(kāi)發(fā)人員什么都想知道。他們不介意問(wèn)問(wèn)題,包括技術(shù)問(wèn)題和業(yè)務(wù)問(wèn)題,盡管這些問(wèn)題聽(tīng)起來(lái)非常簡(jiǎn)單。理解業(yè)務(wù)需求有助于開(kāi)發(fā)者編寫(xiě)更好的代碼!他們不害怕問(wèn)問(wèn)題,因?yàn)樗麄儗?duì)自己的能力有信心。

18. 盡可能將邏輯排除在數(shù)據(jù)庫(kù)之外

這一點(diǎn)可以歸結(jié)為你正在構(gòu)建的應(yīng)用程序的類型,并且僅當(dāng)它不會(huì)影響性能時(shí)才適用。

高級(jí)開(kāi)發(fā)人員知道將數(shù)據(jù)庫(kù)查詢保留為簡(jiǎn)單的 CRUD 操作。CRUD 是指在做計(jì)算處理時(shí)的增加 (Create)、檢索(Retrieve)、更新(Update) 和刪除(Delete)。

接下來(lái),業(yè)務(wù)邏輯層應(yīng)將 CRUD 操作整合在一起。這有助于開(kāi)發(fā)人員了解在哪里尋找業(yè)務(wù)邏輯。如果你在數(shù)據(jù)庫(kù)查詢和代碼中有邏輯,這會(huì)很快變得混亂!

19. 保持代碼簡(jiǎn)潔

保持代碼簡(jiǎn)潔是最好的做法。即使這意味著要編寫(xiě)更多行代碼。下面是相對(duì)較弱的開(kāi)發(fā)人員編寫(xiě)的單行代碼:

return dir.Keys.Any(k => k >= limit) ? dir.First(x => x.Key >= limit).Value : dir[dir.Keys.Max()];

這樣的代碼雖然可以運(yùn)行,但可讀性很低。

原文鏈接:
https://medium.com/javascript-in-plain-english/19-things-i-stole-from-great-developers-85511ff56570



|?整理轉(zhuǎn)載文章為傳播相關(guān)技術(shù),版權(quán)歸原作者所有?|

|?如有侵權(quán),請(qǐng)聯(lián)系刪除?|




免責(zé)聲明:本文內(nèi)容由21ic獲得授權(quán)后發(fā)布,版權(quán)歸原作者所有,本平臺(tái)僅提供信息存儲(chǔ)服務(wù)。文章僅代表作者個(gè)人觀點(diǎn),不代表本平臺(tái)立場(chǎng),如有問(wèn)題,請(qǐng)聯(lián)系我們,謝謝!

嵌入式ARM

掃描二維碼,關(guān)注更多精彩內(nèi)容

本站聲明: 本文章由作者或相關(guān)機(jī)構(gòu)授權(quán)發(fā)布,目的在于傳遞更多信息,并不代表本站贊同其觀點(diǎn),本站亦不保證或承諾內(nèi)容真實(shí)性等。需要轉(zhuǎn)載請(qǐng)聯(lián)系該專欄作者,如若文章內(nèi)容侵犯您的權(quán)益,請(qǐng)及時(shí)聯(lián)系本站刪除。
換一批
延伸閱讀

9月2日消息,不造車的華為或?qū)⒋呱龈蟮莫?dú)角獸公司,隨著阿維塔和賽力斯的入局,華為引望愈發(fā)顯得引人矚目。

關(guān)鍵字: 阿維塔 塞力斯 華為

倫敦2024年8月29日 /美通社/ -- 英國(guó)汽車技術(shù)公司SODA.Auto推出其旗艦產(chǎn)品SODA V,這是全球首款涵蓋汽車工程師從創(chuàng)意到認(rèn)證的所有需求的工具,可用于創(chuàng)建軟件定義汽車。 SODA V工具的開(kāi)發(fā)耗時(shí)1.5...

關(guān)鍵字: 汽車 人工智能 智能驅(qū)動(dòng) BSP

北京2024年8月28日 /美通社/ -- 越來(lái)越多用戶希望企業(yè)業(yè)務(wù)能7×24不間斷運(yùn)行,同時(shí)企業(yè)卻面臨越來(lái)越多業(yè)務(wù)中斷的風(fēng)險(xiǎn),如企業(yè)系統(tǒng)復(fù)雜性的增加,頻繁的功能更新和發(fā)布等。如何確保業(yè)務(wù)連續(xù)性,提升韌性,成...

關(guān)鍵字: 亞馬遜 解密 控制平面 BSP

8月30日消息,據(jù)媒體報(bào)道,騰訊和網(wǎng)易近期正在縮減他們對(duì)日本游戲市場(chǎng)的投資。

關(guān)鍵字: 騰訊 編碼器 CPU

8月28日消息,今天上午,2024中國(guó)國(guó)際大數(shù)據(jù)產(chǎn)業(yè)博覽會(huì)開(kāi)幕式在貴陽(yáng)舉行,華為董事、質(zhì)量流程IT總裁陶景文發(fā)表了演講。

關(guān)鍵字: 華為 12nm EDA 半導(dǎo)體

8月28日消息,在2024中國(guó)國(guó)際大數(shù)據(jù)產(chǎn)業(yè)博覽會(huì)上,華為常務(wù)董事、華為云CEO張平安發(fā)表演講稱,數(shù)字世界的話語(yǔ)權(quán)最終是由生態(tài)的繁榮決定的。

關(guān)鍵字: 華為 12nm 手機(jī) 衛(wèi)星通信

要點(diǎn): 有效應(yīng)對(duì)環(huán)境變化,經(jīng)營(yíng)業(yè)績(jī)穩(wěn)中有升 落實(shí)提質(zhì)增效舉措,毛利潤(rùn)率延續(xù)升勢(shì) 戰(zhàn)略布局成效顯著,戰(zhàn)新業(yè)務(wù)引領(lǐng)增長(zhǎng) 以科技創(chuàng)新為引領(lǐng),提升企業(yè)核心競(jìng)爭(zhēng)力 堅(jiān)持高質(zhì)量發(fā)展策略,塑強(qiáng)核心競(jìng)爭(zhēng)優(yōu)勢(shì)...

關(guān)鍵字: 通信 BSP 電信運(yùn)營(yíng)商 數(shù)字經(jīng)濟(jì)

北京2024年8月27日 /美通社/ -- 8月21日,由中央廣播電視總臺(tái)與中國(guó)電影電視技術(shù)學(xué)會(huì)聯(lián)合牽頭組建的NVI技術(shù)創(chuàng)新聯(lián)盟在BIRTV2024超高清全產(chǎn)業(yè)鏈發(fā)展研討會(huì)上宣布正式成立。 活動(dòng)現(xiàn)場(chǎng) NVI技術(shù)創(chuàng)新聯(lián)...

關(guān)鍵字: VI 傳輸協(xié)議 音頻 BSP

北京2024年8月27日 /美通社/ -- 在8月23日舉辦的2024年長(zhǎng)三角生態(tài)綠色一體化發(fā)展示范區(qū)聯(lián)合招商會(huì)上,軟通動(dòng)力信息技術(shù)(集團(tuán))股份有限公司(以下簡(jiǎn)稱"軟通動(dòng)力")與長(zhǎng)三角投資(上海)有限...

關(guān)鍵字: BSP 信息技術(shù)
關(guān)閉
關(guān)閉