在项目中寻找错误的代码命名
我经常做什么和想什么。
模糊的if条件1)治疗| | 。
上面的代码比下面的代码需要更多的时间来理解。
虽然减少代码行数是一个很好的目标,但更好的目标是尽量减少理解代码所需的时间。
返回值
上面的“$ret”是“我想不出名字”的借口。与其使用这样的空名称,不如选择一个能够描述该实体的价值或用途的名称。
$alias声明该变量用于携带别名。——表示该变量的用途。并可能帮助我们发现缺陷。
一个好的名字应该描述变量的用途或者它所承载的价值。
临时变量
这里,$i是“我的临时变量”,专门用来自动增加统计数据,避免统计点重复。但是对于这个$i来说,最重要的不是临时变量。用charset_index来表示“我的统计数据的下标”更具描述性。
循环迭代器我还在js代码中发现了不好的味道。
我变量名很模糊,所以不要这样做。
像I,J,iter和它这样的名字经常被用作索引和循环迭代器。虽然名字很模糊,但每个人都知道它们的意思是“我是迭代器”。实际上,你用这些名字来表示其他的意思,那会很混乱。所以不要这样。如果非要用I、J、it这样模糊的名字,你应该有很好的理由说服自己。
综上所述,我们在编码的过程中花几秒钟想出一个好名字,你会发现我们的“命名能力”会很快提高。我通常首先想到中国人的名字。如果实在想不出对应的英文名字,我会用翻译工具把想到的中文名字贴上去,然后把变量或者函数的名字剪下来。给我最近看到的一个好听的名字。
版权声明:在项目中寻找错误的代码命名是由宝哥软件园云端程序自动收集整理而来。如果本文侵犯了你的权益,请联系本站底部QQ或者邮箱删除。