<代码整洁之道>第二章 有意义的命名 笔记

第二章主要讲述了,如何给变量、函数、参数、类、包等创建一个有意义的名字。

我觉得这一章的核心思想就一句话:在尽可能简洁的情况下,做到所见即所得

这里我总结了一下作者的建议如下:

  1. 名副其实,通过名称便可以得知,它是什么,做什么事,如何使用。
  2. 简洁明了,言简意赅,且不要过长。
  3. 具备一义性,一语中的,避免歧义而造成误解和纠纷。
  4. 具备很强的可读性。(想想那些代码中的缩写命名,你能组合出多少种意思呢)。
  5. 根据上下文以及语义做有意义的命名区分,比如Info,Data,a,the的使用。
  6. 具备可搜索性。什么叫可搜索性,就是当你通过名称搜索该变量或者方法时,而搜索结果应当尽可能全部都与你所期望的结果一致。
  7. 类名和对象名应该是名词或者名词短语,表明是什么。
  8. 方法名应当是动词或者是动词短语,表明做什么。
  9. 大多数情况下应避免使用单字母变量,单字母可读性差,且不具备解释性。
  10. 可以使用专业术语或者专业领域名称(代码是给开发人员看的,不要怕别人看不懂),使命名更具解释性。
  11. 每个抽象概念对应一个词。怎么理解呢?这里简单举几个个例子:视图我们可以命名为xxxView,均已View结尾;管理器可以命名为xxxManager,比如HttpManager,DownloadManager,CacheManager;拉取数据的方法都以fetch开头,比如fetchUserInfo;上传数据的方法都以post开头,比如postUserInfo。这下就好理解了。
  12. 去掉不必要的修饰语,不要添加不必要的语境,就是说命名要精准或者叫精确。比如,好比有人指着面前的狗问你,它是猫还是狗的时候,该如何回答呢?你应该简洁明了告诉他是狗,而不是说这是一条黑色的带点白色斑点有点脏兮兮的狗。

可加群一起交流共同学习:801216530。

你可能感兴趣的:(<代码整洁之道>第二章 有意义的命名 笔记)