程序員提高代碼可讀性的5個(gè)方法,確保一個(gè)月后仍能讀懂代碼!
好的代碼的可讀性表現(xiàn)在讓人快速理解、輕松維護(hù)、容易擴(kuò)展。
如果用通俗的一句話來(lái)說(shuō),就是別人在閱讀代碼過(guò)程中飆臟話的頻率是衡量你代碼質(zhì)量的唯一標(biāo)準(zhǔn)。
如何提高代碼的可讀性呢?下面給程序員小伙伴們分享5個(gè)技巧:
0、代碼清晰表達(dá)意圖
一個(gè)比較優(yōu)秀的開(kāi)發(fā)者,在閱讀代碼通常不拘泥于編程語(yǔ)言,而是代碼所要表達(dá)的實(shí)質(zhì)。
所以,他會(huì)去搞清楚一件事,代碼的目的是什么,同時(shí)會(huì)忽略它是如何做的。
打個(gè)比方,小學(xué)生閱讀文章都會(huì)關(guān)注詞語(yǔ)本身,而高中生則會(huì)去注意語(yǔ)法和文章傳達(dá)的思想。
我們要遵守的原則是,代碼能夠讓人快速看懂,可以一個(gè)月后能快速讀懂代碼,這是***的要求啦!
1、排版規(guī)范
程序員的代碼排版可是基本功,比如縮進(jìn)和命名要規(guī)范統(tǒng)一,一行不要寫(xiě)太寬,一個(gè)函數(shù)不要寫(xiě)太長(zhǎng),這些都是最基本的。
至少你要確保代碼讓人讀起來(lái)有種賞心悅目的感覺(jué)!
2、注釋清晰
通常而言,注釋?xiě)?yīng)先于代碼存在,而不是編寫(xiě)完代碼之后去補(bǔ)注釋。
注釋?xiě)?yīng)該是說(shuō)明代碼的意圖,代碼注釋貴在精不在多。
它就像是一個(gè)作家在闡述自己寫(xiě)作時(shí)的想法一樣。
3、解釋給別人聽(tīng)
檢驗(yàn)代碼可讀性的最簡(jiǎn)單的方法之一就是給別人解釋代碼,通過(guò)解釋代碼,你可以發(fā)現(xiàn)理解上的漏洞以及代碼的一些細(xì)節(jié)。
你可以講給可愛(ài)的小黃鴨聽(tīng),效果還是杠杠滴~
4、簡(jiǎn)單就是美
牢記一個(gè)代碼可讀性的法則,即簡(jiǎn)單就是美,簡(jiǎn)單可以移動(dòng)一座大山!
你會(huì)發(fā)現(xiàn),保持簡(jiǎn)單的代碼遠(yuǎn)比寫(xiě)出復(fù)雜代碼要難得多,但這是值得的。
另外,不要編寫(xiě)討巧的代碼,取巧只會(huì)讓你過(guò)后花更多的時(shí)間和精力。
***,用先哲的一句話結(jié)尾:
程序?qū)懗鰜?lái)是給人讀的,只是偶爾讓機(jī)器去執(zhí)行一下。– Abelson and Sussman