美文网首页
做有意义的命名

做有意义的命名

作者: 孙广明 | 来源:发表于2019-01-20 12:18 被阅读0次

软件中随处可见命名。我们给变量、函数、参数、类和封包命名。我们给源代码及源码所在的目录命名。我们给 jar 文件、 war 文件 和 ear 文件命名。有很多命名要做、不妨做好它。下面列出几条简单规则。

1. 名副其实

变量、函数或类的名称应该已经答复了所有的大问题。它该告诉你,它为什么会存在,它做了什么事,应该怎么用。如果名称需要注释来补充,那就不算是名副其实。


2. 避免误导

  1. 避免留下掩藏代码本意的错误线索。
    例如:使用某些专有名词作为变量名,使用缩写。
  2. 避免使用与本意相悖的词
    例如:
    String[] accountList = new String[10]; accountList 实质是一个数组对象,命名后缀为
    List产生误导作用。
  3. 避免使用外形相似的命名
    例如:两个变量
  4. 避免使用小写字母 l 与 大写字母 O 作为变量名,跟数组1 和数字 0 难以区分。

3. 做有意义的区分

如果只是为了满足编译器或解释器的需要而写代码,肯定会制造麻烦。

错误示例:

1. 添加数字系列,这样的名称纯属误导。

  • 例如:
    定义两个学生对象
    Student student1 = new Student();
    Student student2 = new Student();

2. 少使用废话,废话都是冗余。要区分名称,要以读者能鉴别之处来区分。

  • 例如:假设已有一个 Product 类,还有ProductInfo 类 和 ProductData 类,虽然名称不同,意思却无差别。 Info 和 Data 就i想 a、an、the 一样,都是意义含混的废话。

  • 例如:如果你需要获取账户信息,你该调用那个方法呢 ?
    getAccount();
    getAccounts();
    getAccountInfo();

  • 例如:
    moneyAmount 和 money 没区别,
    customerInfo 与 customer 没区别,
    accountData 和 account 没区别,
    theMessage 和 message 没区别 。


4. 使用读的出来的名称

错误示例:

1. 使用汉语拼音,只会让别人觉得你写的代码很 low.

2. 使用罕见的英语词汇


5. 使用可搜索的名称

建议:

1. 使用长名称,长名称胜于短名称。

  • 例如: WORK_DAYS_PER_WEEK 比数字 5 好找得多。

6. 避免使用编码

编码已经太多,不需要自找麻烦。


7. 避免使用前缀

不必使用 m_ 前缀来表名成员变量,很多时候阅读代码的人不会去看前缀,直接看后面有意义的名称,前缀反而成了废代码。


8. 接口和实现


9. 类名

类名和对象名应该是名词或者名词短语,不应该是动词。

  • 正例:Customer
  • 反例:CustomerInfo、CustomerData、 Data .

10. 方法名

方法名应该是动词或者动词短语,不应该是名词。

  • 例如:getName(); setName() 等。

11. 避免思维映射

  • 例如:变量 i、j 通常用于 for 循环中,传统惯用这种单字母名词作为循环计数器,并不是一种好的选择。

12. 避免使用双关语

  • 例如:add方法用来添加一个对象,返回结果应该是布尔类型(添加成功或者失败) ,如果你需要添加一个对象并返回添加后产生的新值,建议使用append方法和insert方法。

相关文章

  • Clean Code Notes(代码规范)

    [TOC] Clean Code Notes 1_命名 1.1_命名要点 有意义的命名 有意义的区分 有意义命名部...

  • 做有意义的命名

    软件中随处可见命名。我们给变量、函数、参数、类和封包命名。我们给源代码及源码所在的目录命名。我们给 jar 文件、...

  • Clean Code --第二章

    有意义的命名名副其实注意命名,一旦发现有更好的名称,就换掉旧的,这样做,对你的代码更清晰 2.4 做有意义的区分废...

  • 有意义的命名

    有意义的命名 我们给变量,函数,参数,类和封包命名,我们给源代码及源代码所在目录命名,既然有这么多命名要做,不妨做...

  • R-loop数据分析之R-ChIP(数据预处理)

    文件重命名 我们需要对下载的SRRXXXXX文件进行重命名,毕竟有意义的命名才能方便后续展示。那么,应该如何做呢?...

  • 代码整洁之道

    命名 做有意义的区分 例如:Product类,如果还有ProdcutInfo或者ProduceData,意义无差别...

  • Clean Code 读书笔记

    1.有意义的命名 避免误导 不要把类型或者作用域编进名称里面; 做有意义的区分 Product, ProductI...

  • java编码规范(更新中)

    编码规范 命名规范 任何包名、类名、方法名、属性等都要使用有意义的单词,有意义的命名;命名不在于长,而在于解释 包...

  • 《代码整洁之道》 [(美国)马丁] ——(读书笔记(持续更新)

    第二章:做有意义的命名 —(2017-08-03日) 1.名副其实:选个好的命名,见名知意,变量,或函数,或类冯名...

  • 有意义的命名

    前言 在开发过程中,给变量以及方法提供一个有意义的命名至关重要。有意义的命名对代码可读性的提升有很大帮助。一个项目...

网友评论

      本文标题:做有意义的命名

      本文链接:https://www.haomeiwen.com/subject/mvrxjqtx.html