×
天晴创艺网站建设公司。主要为北京天津全国各地提供网站建设与网页设计制作服务,欢迎大家咨询。您的IP地址是:18.215.62.41。今天是:2020年10月31日,星期六,农历庚子年(鼠),九月十五,现在是:21:23:00,一天过的可真快!今天过的好吗?

网站开发代码的可读性原则

作者:天晴创艺发布时间:2018/12/18 15:01:06浏览次数:10467文章出处:公司网站

      作为一名IT工程师,想要拥有良好的代码素养,首先要让自己的代码可维护,不给别人的维护带来巨大的成本和工作量,其次尽量保证代码的美观可读,整洁的代码人见人爱,如同阅读一本好书,令人心情愉悦。对于可读性,代码应遵循以下三条原则:
      1.可读性基本定理
      可读性基本定理——“代码的写法应当使别人理解它所需的时间最小化”。
      代码风格和原则不是一概而论的,我们经常需要对一些编码原则和方案进行取舍,例如对于三元表达式的取舍,当我们觉得两种方案都占理时,那么唯一的评判标准就是可读性基本定理,无论写法多么的高超炫技,最好的代码依旧是让人第一时间能够理解的代码。
      2. 有意义的名称
      代码的可读性绝大部分依赖于变量和函数的命名,一个好的名称能够一针见血地帮助维护者理解逻辑,如同写文章中的“文笔”,文笔优异者总能将故事娓娓道来,引人入胜。
      不过要起好名称还是很难的,尤其是我们不是以英语为母语,更是添加了一层障碍,有些人认为纠结在名称上会导致效率变低,开发第一时间应该完成需求的开发。这样说并没有错,我们在开发过程中应当专注于功能逻辑,但不要完全忽视命名,所谓“文笔”是需要锻炼的,思考的越多,命名就会愈加的水到渠成,到后来也就不太会影响工作效率了。
      在这里推荐鲍勃大叔提到的童子军规,每一次看自己的代码,都进行一次重构,最简单的重构便是改名,也许一开始觉得命名还比较贴合,但逻辑越写越不符合初始的命名了,当回顾代码时,我们可以顺手对变量和方法进行重新命名,现代编辑工具也很容易做到这一点。
     文不对题的命名是最可怕的,如:
网站开发代码
       这个函数被命名为check*开头的,本意是检测课程时间是否冲突,但内部逻辑却包含了支付整个流程,此时对于调用者来说,如果不去细看内部逻辑,很有可能就会错误的认为check函数没有副作用导致事故发生。
      3.适当的注释维护
      注释是一个比较有争议性的话题,有人认为可读的函数变量就很清晰,不需要额外的注释,且注释有不可维护性北京自适应网站建设,如:
网站开发代码
      实际上,这个字段的含义早已发生了改变,但由于修改者只修改了逻辑,并没有注意到这一行注释,导致这个老注释提供了错误信息,此时的注释不仅变成了无效注释,甚至会导致维护人的误解,造成bug的产生。
      对于这种情况,要么维护注释,要么在注释里面注明接口文档,维护文档,在其他情况下,适当的注释是有必要的,对于复杂的逻辑,如果有一个简练的注释广州新际网络,对于代码可读性的帮助是极大的,但有些不必要的注释可以去掉,注释的取舍关键在于可读性基本定理,如:
网站开发代码
      对于上述逻辑来说,虽然通过变量可以大致猜出功能含义,但一眼看上去就能清晰掌握逻辑结构北京华宇阳光教育科技中心,归功于注释的简明与清晰。

文章来源:公司网站

文章标题:网站开发代码的可读性原则

文本地址:https://www.bjtqcy.com/info_745.html

收藏本页】【打印】【关闭

本文章Word文档下载:word文档下载 网站开发代码的可读性原则

用户评论

客户评价

专业的网站建设、响应式、手机站微信公众号开发

© 2010-2020 天晴创艺 版权所有 京ICP备16050845号

关注公众号 关注公众号

进入手机版 进入手机版