在项目中寻找代码的坏味道(命名)

开发 后端
我们在编码的过程中,多花几秒钟想出一个好名字,你会发现我们的“命名能力“很快提升上去。我一般是先想中文名字,如果实在想不出对应的英文名字,我就会用翻译工具把想到的中文贴上去,进行裁剪命名变量或者函数名称。

介绍

这段时间一直做项目,所以相对忙碌些,今天终于有时间回过头来好好看一下自己写的代码,看哪里有问题,哪里有“坏味道”。

慢慢过,慢慢回忆代码。开始捕捉坏味道。

常做的和常想的事情

晦涩的if条件

1)对于||的处理

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

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

返回值

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

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

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

临时变量

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

循环迭代器

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

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

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

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

总结

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

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

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

原文链接:http://www.cnblogs.com/baochuan/archive/2012/07/12/2588317.html

【编辑推荐】

  1. PHP开源框架CodeIgniter发布2.1.1版
  2. 图文并茂PHP跟老大的对话
  3. 图文并茂的解释“天天团购”坏代码
  4. PHP file_exists有多坑爹
  5. jQuery和PHP打造功能开关效果
责任编辑:张伟 来源: 川山甲的博客
相关推荐

2012-07-13 09:38:15

项目代码

2012-07-19 10:42:17

项目

2020-06-12 08:21:58

JavaScript代码开发

2019-10-11 09:07:46

Java代码对象

2015-07-29 13:22:40

.NET代码

2021-05-26 11:50:37

代码优化Java

2018-08-24 21:25:02

编程语言代码重构GitHub

2022-01-26 10:29:24

微服务循环依赖代码

2022-05-07 10:01:20

好代码坏代码

2020-12-01 08:36:10

代码程序员函数

2023-10-12 14:22:45

2020-04-26 10:01:14

编程学习技术

2009-06-29 15:51:48

Spring容器

2022-08-15 18:22:22

JS代码

2022-06-21 07:41:08

FCPJS代码

2018-05-09 12:27:34

Linux命令寻找文件

2015-03-21 06:41:50

oauth2.0监控宝

2022-12-08 10:40:06

声明式事务AOP

2010-12-08 09:38:43

C#枚举

2021-09-03 10:08:53

JavaScript开发 代码
点赞
收藏

51CTO技术栈公众号