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

 更新时间:2012年07月14日 10:48:48   作者:  
这段时间一直做项目,所以相对忙碌些,今天终于有时间回过头来好好看一下自己写的代码,看哪里有问题,哪里有坏味道

常做的和常想的事情

晦涩的if条件

1)对于||的处理

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

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

 

返回值

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

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

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

临时变量

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

循环迭代器

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

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

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

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

总结

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

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

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

 

相关文章

  • php简单解析mysqli查询结果的方法(2种方法)

    php简单解析mysqli查询结果的方法(2种方法)

    这篇文章主要介绍了php简单解析mysqli查询结果的方法,结合实例形式简单列举了查询结果存入对象与数组的两种实现方法,需要的朋友可以参考下
    2016-06-06
  • php设计模式之简单工厂模式详解

    php设计模式之简单工厂模式详解

    这篇文章主要介绍了php设计模式的简单工厂模式,又称为静态工厂方法模式,是一种重要的PHP设计模式,需要的朋友可以参考下
    2014-09-09
  • PHP访问MYSQL数据库封装类(附函数说明)

    PHP访问MYSQL数据库封装类(附函数说明)

    MYSQL 数据访问方式,php4支持以mysql_开头的过程访问方式,php5开始支持以mysqli_开头的过程和mysqli面向对象访问方式,本封装类以mysql_封装
    2010-12-12
  • php中判断文件存在是用file_exists还是is_file的整理

    php中判断文件存在是用file_exists还是is_file的整理

    在写程序时发现在判断文件是否存在时,有两种写法,有的人用了is_file,有的人用了file_exists,用哪个更好或者说更合适呢
    2012-09-09
  • Lumen timezone 时区设置方法(慢了8个小时)

    Lumen timezone 时区设置方法(慢了8个小时)

    今天用 Lumen 框架写代码时, 也是初次体验 Lumen, 遇到了一个问题, 从数据库里查出的时间比数据库里保存的 TIMESTAMP 时间慢了8个小时, 很明显这是一个时区设置的问题, 本以为可以在1分钟内解决的, 但是我错了
    2018-01-01
  • php实现ip白名单黑名单功能

    php实现ip白名单黑名单功能

    本文给大家分享了2个php用于实现黑白名单的实用函数,分别是安全IP检测函数和获取客户端IP函数,注释里解释的非常清楚,这里我就不多废话了。
    2015-03-03
  • php简单防盗链验证实现方法

    php简单防盗链验证实现方法

    这篇文章主要介绍了php简单防盗链验证实现方法,通过$_SERVER['HTTP_REFERER']获取来路页面URL再进行判断进而实现对非本地URL的拦截功能,需要的朋友可以参考下
    2016-07-07
  • PHP伪静态Rewrite设置之APACHE篇

    PHP伪静态Rewrite设置之APACHE篇

    Rewirte主要的功能就是实现URL的跳转和隐藏真实地址,基于Perl语言的正则表达式规范。平时帮助我们实现拟静态,拟目录,域名跳转,防止盗链等
    2014-07-07
  • PHP实现更改hosts文件的方法示例

    PHP实现更改hosts文件的方法示例

    这篇文章主要介绍了PHP实现更改hosts文件的方法,结合具体实例形式分析了php操作hosts文件的相关读取、设置、删除等实现技巧,需要的朋友可以参考下
    2017-08-08
  • PHP 解决utf-8和gb2312编码转换问题

    PHP 解决utf-8和gb2312编码转换问题

    就一个很简单的函数iconv();但是就是这个函数在网上找了很多例子,都无法成功转换,这是为什么呢?
    2010-03-03

最新评论