WdBly Blog

懂事、有趣、保持理智

周维的个人Blog

懂事、有趣、保持理智

站点概览

周维 | Jim

603927378@qq.com

推荐阅读

代码整洁之道 - 有意义的命名

读Robert C. Martin 的《clean Code》之有意义的命名章节记。

在程序中,命名无处不在,我们给变量、函数、参数、类命名,给目录、文件命名,但是取个好的名字不是一个简单的事情,需要符合几条简单的规则。

名副其实

最简单也是最重要的规则。

对变量或者文件命名时,名称要表达出其在上下文的含义和代表的角色。

避免误导

peopleList,在Javascript中,list通常代表的是一个数组类型,如果peopleList本身代表的只是一个Object类型,则会造成误导,其它程序员有可能尝试通过for循环来遍历它。

好的变量名可以是peoplespeopleGroup等。

再比如小写字母l和o,看上去和数字1、0形似,容易形成误导。

做有意义的区分

如以数字系列命名:
a1、a2…,这样的命名没有向读者传达一个有意义的信息。

变量名中出现的无意义的废话:

ProductProductInfoProductData,它们的名称虽然不同,但是意义却相同。

namenameString虽然也不相同,但是String的后缀就是无意义的多余,难度name还能是一个浮点数吗?

使用能读出来的名称

能直接读出来的变量名能帮助我们记忆和理解。

同时,在代码分享或谈论时,能避免开发者想个傻鸟(指某些不易读出来的变量造成会议中的囧破)。

使用可搜索的名称

变量或者文件名应该利用搜索。

避免使用编码

???

类名和对象名

类名和对象名应该是一个名词或者名词短句: BookAccount等。而不是一个动词。

方法名

方法名应该是一个动词或者动词短语: deletePagesaveOrder等具有get,set,is,has前缀。

提交

全部评论0

暂时没有评论...