程序员提高代码可读性的5个方法,确保一个月后仍能读懂代码!
好的代码的可读性表现在让人快速理解、轻松维护、容易扩展。
如果用通俗的一句话来说,就是别人在阅读代码过程中飙脏话的频率是衡量你代码质量的唯一标准。
如何提高代码的可读性呢?下面w3cschool给程序员小伙伴们分享5个技巧:
0、代码清晰表达意图
一个比较优秀的开发者,在阅读代码通常不拘泥于编程语言,而是代码所要表达的实质。
所以,他会去搞清楚一件事,代码的目的是什么,同时会忽略它是如何做的。
打个比方,小学生阅读文章都会关注词语本身,而高中生则会去注意语法和文章传达的思想。
我们要遵守的原则是,代码能够让人快速看懂,可以一个月后能快速读懂代码,这是最低的要求啦!
1、排版规范
程序员的代码排版可是基本功,比如缩进和命名要规范统一,一行不要写太宽,一个函数不要写太长,这些都是最基本的。
至少你要确保代码让人读起来有种赏心悦目的感觉!
2、注释清晰
通常而言,注释应先于代码存在,而不是编写完代码之后去补注释。
注释应该是说明代码的意图,代码注释贵在精不在多。
它就像是一个作家在阐述自己写作时的想法一样。
3、解释给别人听
检验代码可读性的最简单的方法之一就是给别人解释代码,通过解释代码,你可以发现理解上的漏洞以及代码的一些细节。
你可以讲给可爱的小黄鸭听,效果还是杠杠滴~
4、简单就是美
牢记一个代码可读性的法则,即简单就是美,简单可以移动一座大山!
你会发现,保持简单的代码远比写出复杂代码要难得多,但这是值得的。
另外,不要编写讨巧的代码,取巧只会让你过后花更多的时间和精力。
最后,用先哲的一句话结尾:
程序写出来是给人读的,只是偶尔让机器去执行一下。– Abelson and Sussman