web開(kāi)發(fā)中如何寫(xiě)好代碼

本文小編為大家詳細(xì)介紹“web開(kāi)發(fā)中如何寫(xiě)好代碼”，內(nèi)容詳細(xì)，步驟清晰，細(xì)節(jié)處理妥當(dāng)，希望這篇“web開(kāi)發(fā)中如何寫(xiě)好代碼”文章能幫助大家解決疑惑，下面跟著小編的思路慢慢深入，一起來(lái)學(xué)習(xí)新知識(shí)吧。

1、編碼規(guī)范

每種編程語(yǔ)言、每個(gè)框架都有自己的一套編碼規(guī)范和編碼最佳實(shí)踐方式，例如 PEP8 是 Python 語(yǔ)言的編碼規(guī)范，作為 Python 開(kāi)發(fā)者，每個(gè)人至少要將 PEP8 讀上三五遍，熟記于心并運(yùn)用在項(xiàng)目中。

2、文檔注釋

程序員最討厭的兩件事情：一，別人的項(xiàng)目沒(méi)有文檔和注釋?zhuān)?，自己的?xiàng)目要寫(xiě)文檔和注釋。

經(jīng)常看到一些項(xiàng)目連起碼的 REAMDME 文件都沒(méi)有，這跟demo沒(méi)什么區(qū)別。如果你的項(xiàng)目沒(méi)有文檔，一旦有新人進(jìn)來(lái)接手也是一臉懵逼，還顯得非常業(yè)余。所以，一個(gè)正經(jīng)的項(xiàng)目至少要說(shuō)明項(xiàng)目的是做什么的，用了哪些東西，程序怎么跑起來(lái)等等。

簡(jiǎn)單的代碼自然無(wú)需寫(xiě)注釋?zhuān)己玫拇a自身就是文檔和注釋?zhuān)侨绻休^復(fù)雜的代碼邏輯就必須用注釋來(lái)加以說(shuō)明你當(dāng)時(shí)寫(xiě)這段代碼是如何思考的，否則隔兩個(gè)月自己都不知道寫(xiě)的什么爛代碼，還在罵這是哪個(gè)傻逼寫(xiě)的。所以，我們寫(xiě)注釋?xiě)?yīng)該在該寫(xiě)的時(shí)候才寫(xiě)，寫(xiě)多了或者寫(xiě)少了都不合適。還有一種情況就是過(guò)期的注釋?zhuān)枨笞兏a更新后，發(fā)現(xiàn)注釋還是舊的。

雖然Python是一門(mén)優(yōu)雅簡(jiǎn)潔的語(yǔ)言，但是同樣離不開(kāi)注釋的幫助，畢竟，代碼是寫(xiě)給人看的。

3、避免重復(fù)代碼

軟件設(shè)計(jì)原則里面有個(gè)DRP原則，就是在一個(gè)項(xiàng)目里面不要寫(xiě)重復(fù)的代碼，如果同樣的邏輯出現(xiàn)超過(guò)兩次，那么你就考慮將它進(jìn)行封裝成為一個(gè)函數(shù)或者公有方法。過(guò)多重復(fù)的代碼到后面將導(dǎo)致很多潛在的問(wèn)題，一處有問(wèn)題，導(dǎo)致處處都有改動(dòng)。

4、測(cè)試覆蓋率

測(cè)試驅(qū)動(dòng)開(kāi)發(fā)（TDD）是目前主流的開(kāi)發(fā)模式，但是我們往往因?yàn)轫?xiàng)目進(jìn)度或者懶惰，而將單元測(cè)試忽略了。沒(méi)有單元測(cè)試的代碼就像一座危樓，你永遠(yuǎn)都不知道里面有哪些坑，因?yàn)橐坏└牧艘惶幋a，你無(wú)法預(yù)知對(duì)整個(gè)系統(tǒng)有什么影響，而單元測(cè)試是對(duì)代碼質(zhì)量的一種保障，測(cè)試覆蓋率越高，潛在問(wèn)題越少。

5、安全意識(shí)

安全問(wèn)題沒(méi)發(fā)生前都是小事，一旦發(fā)生將是不可估量的大事情，幾年前CSDN這么大一個(gè)網(wǎng)站竟然還鬧出將密碼用明文存儲(chǔ)的笑話，可見(jiàn)程序員的安全意思有多低，密碼至少要做HASH存儲(chǔ)并加鹽處理。去年時(shí)候大疆的程序員將服務(wù)器的key上傳到github也是典型的安全意思缺乏。什么東西該同步到代碼庫(kù)什么東西不該放要區(qū)分清楚。常見(jiàn)的web安全也要清楚，像SQL注入，CSRF、XSS攻擊的基本原理以及如何預(yù)防等等。

6、設(shè)計(jì)與架構(gòu)

如果設(shè)計(jì)架構(gòu)錯(cuò)了，代碼寫(xiě)的再好也白搭，好比建房子設(shè)計(jì)錯(cuò)了，房子在漂亮也華而不實(shí)，可能隱藏重大安全隱患。合理的設(shè)計(jì)與架構(gòu)在于根據(jù)業(yè)務(wù)做合理的取舍，遵循逐步演進(jìn)原則，切忌無(wú)腦跟風(fēng)參考 BAT 規(guī)模量級(jí)來(lái)設(shè)計(jì)你的系統(tǒng)，好的系統(tǒng)都是演變過(guò)來(lái)的。拋開(kāi)業(yè)務(wù)談技術(shù)都是耍流氓。

讀到這里，這篇“web開(kāi)發(fā)中如何寫(xiě)好代碼”文章已經(jīng)介紹完畢，想要掌握這篇文章的知識(shí)點(diǎn)還需要大家自己動(dòng)手實(shí)踐使用過(guò)才能領(lǐng)會(huì)，如果想了解更多相關(guān)內(nèi)容的文章，歡迎關(guān)注億速云行業(yè)資訊頻道。