美文网首页
可读代码的艺术3 命名下

可读代码的艺术3 命名下

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

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

这个原则和昨天的可能存在重叠的部分,不过今天这一part更强调的是尽量没有二义性。

如果只是原则,那么这又是一个所有人都能明白的事情,意义不太大。好在书中给出了一系列的例子,这些例子即可以对号入座去避免,也可以引发进一步思考。

列举如下:典型的二义性的词

filterxxx: 过滤某些数据,那么到底是保留xxx还是去除xxx呢?截然相反的含义。

limitxxx:上限下限,他的歧义之处在于xxx到底上下限这个数本身有没有超出限制是模糊的,建议改为min,max,显然取等于的时候是不超限的。

类似的start,stop:从xx开始到xx结束,歧义之处在于xx到底是否被包含是模糊的,更好的命名是first,last。

bool变量的命名,请加上判断语前缀,is,has,can等明确区分变量的true/false含义。 经C同学提醒,因为一些框架的特别处理,变量加is前缀可能带来问题,不建议使用。

还有一类高级的歧义,就是隐含意思的歧义,比如通常我们会认为getxxx是一个简单操作,是速度很快的,如果getxxx方法有一个复杂的逻辑,有较大的性能开销,请用其他词语替代,比如findxxx.。

类似的还是size(),如果本身有性能开销,请慎用此名,通常使用方会认为其开销很小而产生错误的判断。

我觉得上面这些例子本身就很有价值,在日常能注意使用就是一大进步了。如果能举一反三,触类旁通,那就进入了艺术的门槛了。

相关文章

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

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

  • 代码可读性

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

  • 编写可读代码的艺术

    【代码质量】: 代码行数、时间复杂度、内存消耗,准确率; 《clean code》:在代码阅读过程中人们说脏话的频...

  • 编写可读代码的艺术

    来源 《编写可读代码的艺术》 第2章 把信息装到名字里 1. 选择专业名词 找到更有表现力的词 2. 避免泛泛的名...

  • 编写可读代码的艺术

    以下是书里文字的引用与整理 前言 可读性基本定理:代码的写法应当使别人理解它所需的时间最小化。 一、表面层次的改进...

  • 《编写可读代码的艺术》

    1.调整心态认识到编写可读代码的必要性。在编写可拓展代码,可用代码和可读代码之间的优先级,编写可读代码较高;克服思...

  • 编写可读代码的艺术

    1.写在前面 最近花了一个周的零星时间,看了《编写可读代码艺术》,收获颇多。虽然平时也经常使用书中提到的一些方法编...

  • 编写可读代码的艺术

    "阅读本文大约需要 5 分钟" 很多程序员在学习一门新的编程语言时,会先学习基础的语法和自带的基础库,稍加熟练后便...

  • 编写可读代码的艺术

    先放大佬的视频教学地址:https://github.com/biezhi/write-readable-code...

  • 编写可读艺术的代码

    前言 编写代码,实质是在梳理逻辑,为了完善整个逻辑流程,我们借用编程语言的变量、函数、流程控制、循环、注释、方法等...

网友评论

      本文标题:可读代码的艺术3 命名下

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