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