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

5年以前  |  阅读数:827 次  |  编程语言:PHP 

常做的和常想的事情

晦涩的if条件

1)对于||的处理

                            ![](https://codingsky.oss-cn-hangzhou.aliyuncs.com/cdn/codingsky/upload/img/blog/9971b7a712068bfccd8abca0c58a5f1a.png)上面的代码要比下面的代码理解起来花更多的时间 

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

返回值

                               ![](https://codingsky.oss-cn-hangzhou.aliyuncs.com/cdn/codingsky/upload/img/blog/9971b7a712068bfccd8abca0c58a5f1a.png)上面的"$ret"是"我想不出名字"的托词。与其使用这样空洞的名字,不如挑一个能描述这个实体的值或者目的的名字。

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

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

临时变量

                             ![](https://codingsky.oss-cn-hangzhou.aliyuncs.com/cdn/codingsky/upload/img/blog/9971b7a712068bfccd8abca0c58a5f1a.png) 这里的$i是"我的临时变量",专门用来让统计数据自动增加,避免统计点的重复。但是对这个$i来讲最重要的并不是临时变量。用charset_index表示"我的统计数据的下标",更具"描述性"。 

循环迭代器

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

                             ![](https://codingsky.oss-cn-hangzhou.aliyuncs.com/cdn/codingsky/upload/img/blog/9971b7a712068bfccd8abca0c58a5f1a.png)i变量名字很空泛,所以不要这么做。 

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

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

总结

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

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

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

 相关文章:
PHP分页显示制作详细讲解
SSH 登录失败:Host key verification failed
获取IMSI
将二进制数据转为16进制以便显示
获取IMEI
文件下载
贪吃蛇
双位运算符
PHP自定义函数获取搜索引擎来源关键字的方法
Java生成UUID
发送邮件
年的日历图
提取后缀名
在Zeus Web Server中安装PHP语言支持
让你成为最历害的git提交人
Yii2汉字转拼音类的实例代码
再谈PHP中单双引号的区别详解
指定应用ID以获取对应的应用名称
Python 2与Python 3版本和编码的对比
php封装的page分页类完整实例