• 技术
    技术

    代码的艺术-命名

    在编写代码过程中,无论是变量,类还是函数等等,一个清晰可以理解的名字,是至关重要的,能够让别人更加清晰的了解你的思路以及代码的含义。 可以说,每一个命名,都是一个简短的注释。 一、选择具有清晰表达含义的命名 日常编码中,我们经常用到get, size等进行命名,但实际上其并没有准确的表达出需要表达的信息,别人能够从中获取到的信息很少。 比如说get,get到了什么,从哪里get, 缓存还是数据库,或者从接口获取等等,这些信息都没有清晰的表达出来。举例来说,如果我们用这样的名字,如getUserNameFromCache,是不是更加的清晰了呢? 下面同样举了一些常见的命名词汇,准确的运用这些词汇,能够让你在命名时,更好的表达自己的代码逻辑和作用。 代码的艺术-常用词汇 二、避免使用空洞的名字 何为空洞的名字?这里指的就是tmp, retval, foo这类名字。 以tmp举例来说,如果变量的唯一目的就是临时存储,如: 这时用tmp就很好,因为它的作用就仅仅只是临时存储,且生命周期只是几行代码之间。 但如果不是这种场景,仅仅只是因为懒惰就是用类似tmp之类的名字,就有些不合时宜了。 即便有些场景,确实是临时存储的含义,但最好也要更加明确些信息,如: tmpFile, tmpCache等等,不要只是单纯的tmp了事。 同时,常用的另外一种情况就是循环迭代的时候,我们常用的都是i, j, k,或者 k, v, key, val, 如果可以的话,换成具体表达含义的词汇会更好,如: 三、命名中尽可能附带更多的信息 如果关于一个变量,有什么更重要的事情必须让读者知道,那么将额外的词加入到命名中就是一个非常好的做法。 如我们最常见的场景,数据库中有很多的数据表,很多的表里面都有一个字增ID字段,如果我们将这个字段都命名为 id , 那么在代码中,就会出现大量的 id…

  • 技术
    技术

    代码的艺术-常用词汇

    以下是整理的一些我们在编码过程中,经常会用到的一些词汇,希望能够让你在命名变量、类、函数等时,能够使用更加合适的命名。 成对反义词 add 添加 remove 移除 input 输入 output 输出 insert 插入 delete 删除 create 创建 destory 销毁 get 获取 release 释放 show 显示 hide 隐藏 start 开始 stop 停止 open 打开 close…