美文网首页
可读代码的艺术2 命名上

可读代码的艺术2 命名上

作者: 大笑的篷蒿人 | 来源:发表于2022-03-03 21:21 被阅读0次

继续艺术的探寻之路,昨天说了代码可读性的重要,今天就来具体的内容了。

第一部分叫表面层次的改进,千万别觉得表面层次的改进不那么重要,按照书里的逻辑,表面层次的改进是最值得进行的,因为他的影响面最少,而且无处不在。

说到无处不在的表面,首当其冲的就是命名,命名是如此的重要以至于作者花了上下两节从多角度进行全方位的提升。

第一个提升角度叫 把信息放到名字里,顾名思义就是取有意义的名字。有六个原则:

选择专业的词
避免泛泛的名字
要具体不要抽象
加前后缀
名字的长度
名字的格式

分别说一下:第一点还是挺难的,考的是语言水平,还是英语言水平(当然用拼音取名的除外)。英语里有一些近义词,尽可能用得准确。

举一个例子,比如stop这个词,很多方法名可能会用。但是细想一下,可能还是可以更精确一些,比如根据stop后能否恢复继续执行的角度,可以取名为terminate,或者pause,更加精确。

第二点看似简单,但是做到不容易,比如说在多层循环中用I,J,K来命名计数器被认为是可以改进的,答案我就不公布了,虽然有些争议,不过还是有些道理的。

思考改进

第三点,第四点和第一点有点像,实际上就是让名字更加符合他的含义。

第五点名字的长度有点意思,书中提出了一些原则,作用域小的命名可以更短一些,作用域大的要清楚一点;不那么明确的缩写谨慎使用;无意义或者重复含义的词可以去掉。

第六点实际上是命名规范,比如常量全大写,什么时候用下划线连接,方法名应该用动词,等等吧,如果我们还没有的话,可以搞一个。

小结一下:思考编程重命名开始,用尽可能简短的命名来准确表达其中含义。

相关文章

  • 可读代码的艺术2 命名上

    继续艺术的探寻之路,昨天说了代码可读性的重要,今天就来具体的内容了。 第一部分叫表面层次的改进,千万别觉得表面层次...

  • 可读代码的艺术3 命名下

    继续艺术之旅,昨天说了命名的前半部分,原则是要取一个有充分含义的名字,今天讲的是后半部分,讲的是要用一些没有歧义的...

  • 如何写好一个第三方框架

    提高代码可读性: 命名:命名是一个很重要很关键的环节,好的命名可以提高代码的可读性,差的命名会让人丈二和尚摸不着头...

  • golang命名规范

    可读性是评判好代码的一个标准,好的命名对可读性很重要,现在开始让自己的go代码有一个良好的命名规范吧 好的命名一般...

  • JS代码优化浅谈

    本文主要介绍一下如何让代码整洁可读的几点建议,总体是为了让代码逻辑及结构更加清晰,增加可读性。 一、命名一切命名都...

  • 代码可读性

    这是一篇结合项目代码与《编写可读艺术的代码》一书结合的读书笔记 代码应当易于理解 《编写可读艺术的代码》这本书告诉...

  • AMD_CMD_RequireJS

    题目1: 为什么要使用模块化? 解决命名冲突 便于依赖管理 提高代码的可读性 代码解耦,提高代码复用性 题目2: ...

  • AMD_CMD_RequireJS

    1. 为什么要使用模块化? 解决命名冲突; 依赖管理; 提高代码可读性; 代码解耦,提高代码的复用性。 2.CMD...

  • AMD_CMD_RequireJS

    题目1: 为什么要使用模块化? 可以解决命名冲突 管理依赖 提高代码的可读性 代码解耦,提高代码的复用性 题目2:...

  • 高级4 AMD_CMD_RequireJS

    1: 为什么要使用模块化? 解决命名冲突 依赖管理 提高代码可读性 代码解耦,提高复用性 2: AMD、Commo...

网友评论

      本文标题:可读代码的艺术2 命名上

      本文链接:https://www.haomeiwen.com/subject/oiiurrtx.html