在项目中寻找代码的坏命名

常做的和常想的事情

在项目中寻找代码的坏命名

晦涩的if条件

1)对于||的处理

在项目中寻找代码的坏命名

                                上面的代码要比下面的代码理解起来花更多的时间

在项目中寻找代码的坏命名

 尽管减少代码行数是一个好目标,但把理解代码所需的时间最小化是一个更好的目标。

在项目中寻找代码的坏命名

 

返回值

在项目中寻找代码的坏命名

上面的"$ret"是“我想不出名字“的托词。与其使用这样空洞的名字,不如挑一个能描述这个实体的值或者目的的名字。

在项目中寻找代码的坏命名

                                     $alias声明了这个变量是用来承载别名的——标明了这个变量的目的。并且可能帮我们找到缺陷

在项目中寻找代码的坏命名

好的名字应当描述变量的目的或者它所承载的值。

在项目中寻找代码的坏命名

临时变量

在项目中寻找代码的坏命名

                                  这里的$i是“我的临时变量",专门用来让统计数据自动增加,避免统计点的重复。但是对这个$i来讲最重要的并不是临时变量。用charset_index表示“我的统计数据的下标”,更具“描述性”。

在项目中寻找代码的坏命名

在项目中寻找代码的坏命名

循环迭代器

我在我的js代码中也发现了坏味道。

在项目中寻找代码的坏命名

                                 i变量名字很空泛,所以不要这么做。

在项目中寻找代码的坏命名

像i,j,iter和it等名字常用做索引和循环迭代器。尽管名字很空泛,但是大家都知道它们的意思是“我是一个迭代器“。——实际上你用这些名字来表示其他含义,那会很混乱。所以不要这么做。

如果你非要用i,j,it这样空泛的名字,那么你要有个好的理由说服自己。

在项目中寻找代码的坏命名

总结

  我们在编码的过程中,多花几秒钟想出一个好名字,你会发现我们的“命名能力“很快提升上去。

  我一般是先想中文名字,如果实在想不出对应的英文名字,我就会用翻译工具把想到的中文贴上去,然后进行裁剪命名变量或者函数名称。

赠送一张最近看到的不错的命名

在项目中寻找代码的坏命名

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:http://www.heiqu.com/b41449b9dfbb1bc1d53699fd3ebe4b4f.html