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

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

常做的和常想的事情

晦涩的if条件

1)对于||的处理

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

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

 

返回值

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

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

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

临时变量

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

循环迭代器

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

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

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

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

总结

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

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

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

 

相关文章

  • php自定义截取中文字符串-utf8版

    php自定义截取中文字符串-utf8版

    本文主要介绍了php自定义截取中文字符串的方法,具有很好的参考价值,下面跟着小编一起来看下吧
    2017-02-02
  • PHP PDO函数库(PDO Functions)

    PHP PDO函数库(PDO Functions)

    PDO是一个“数据库访问抽象层”,作用是统一各种数据库的访问接口,与mysql和mysqli的函数库相比,PDO让跨数据库的使用更具有亲和力.
    2009-07-07
  • php中Ioc(控制反转)和Di(依赖注入)

    php中Ioc(控制反转)和Di(依赖注入)

    最近在使用ThinkPHP5框架,看了下他的源码,发现有很多地方也用到了依赖注入(控制反转),觉得有必要和大家简单聊一聊什么是依赖注入以及怎么使用它。
    2017-05-05
  • [PHP]实用函数2

    [PHP]实用函数2

    [PHP]实用函数2...
    2007-11-11
  • php判断IP地址是否在多个IP段内

    php判断IP地址是否在多个IP段内

    这篇文章主要为大家详细介绍了php判断IP地址是否在多个IP段内,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-08-08
  • 解析用PHP实现var_export的详细介绍

    解析用PHP实现var_export的详细介绍

    本篇文章是对使用PHP实现var_export的方法进行了详细的分析介绍,需要的朋友参考下
    2013-06-06
  • php获取当前网址url并替换参数或网址的方法

    php获取当前网址url并替换参数或网址的方法

    今天在项目中用到的两个函数,自己写了下,备用,需要的朋友也可以直接使用了,推荐第一个函数为获取,后面为相关的处理参数。
    2010-06-06
  • php+ajax实时输入自动搜索匹配的方法

    php+ajax实时输入自动搜索匹配的方法

    这篇文章主要介绍了php+ajax实时输入自动搜索匹配的方法,实例分析了两种实现方法,是非常实用的技巧,需要的朋友可以参考下
    2014-12-12
  • PHP中call_user_func_array回调函数的用法示例

    PHP中call_user_func_array回调函数的用法示例

    这篇文章主要给大家介绍了PHP中call_user_func_array回调函数的用法,文中给出了详细的示例代码,相信对大家的理解和学习很有帮助,有需要的朋友们可以参考借鉴,下面来一起学习学习吧。
    2016-11-11
  • php表单提交问题的解决方法

    php表单提交问题的解决方法

    不是第一次写表单提交了,但还是遇到了无法解决的问题。研究了将近一天,问了N多网友,最终解决了问题,过程颇为曲折。感谢大家的帮助。
    2011-04-04

最新评论