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

yipeiwu_com7年前PHP代码库

常做的和常想的事情

晦涩的if条件

1)对于||的处理

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

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

 

返回值

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

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

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

临时变量

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

循环迭代器

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

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

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

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

总结

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

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

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

 

相关文章

浅析PHP数据导出知识点

最近在做后台管理的项目,后台通常有数据导出到 excel 的需要,经过之前搜索通常推荐使用的是 php excel ,我经常使用的是 laravel ,对于 php excel 也有很好...

php开发工具之vs2005图解

php开发工具之vs2005图解

为什么会想到用vs2005呢? 一是有感于vs开发.net应用程序,或者asp.net时候的强大。。。。。一直很怀念 二是 vs是个很全面的编辑器,甚至图片都可以直接打开编辑,对于类似我...

PHP内核探索:变量存储与类型使用说明

先回答前面一节的那个问题吧。 复制代码 代码如下:<?php    $foo = 10;    $b...

PHP使用JpGraph绘制折线图操作示例【附源码下载】

PHP使用JpGraph绘制折线图操作示例【附源码下载】

本文实例讲述了PHP使用JpGraph绘制折线图操作。分享给大家供大家参考,具体如下: 下载jpgraph类库,使用的是src目录下的类文件。 require_once './src...

SESSION信息保存在哪个文件目录下以及能够用来保存什么类型的数据

1.SESSION信息保存在哪? 复制代码 代码如下: <?php session_start(); $_SESSION['name']='marcofly'; ?> se...