Clean Code Reading Note(一)

最近在读一些书,想和大家分享下读书的乐趣和学到的知识。目前读书的系列大都是专业相关的,例如《Clean Code, 《Refactoring-Improving the design of the existing code》, 《Pro-Objective-C Design Pattern for iOS》等等(有些是重读)。当然还有《out of control》这类午后读物。多读书,多看报,提升自己,排解寂寞。

这篇我们来分享读《Clean Code》(代码整洁之道)第二章节的读后感。

第二章节讲的事Meaningful Names, 意思是在我们写代码时,需要用到有意义能自我解释的命名方式。这部分内容不涉及技术,但是可以帮助我们写出能让他人和未来的自己读懂的代码。我会结合书中的标准和我写iOS程序的经验来批判的接受和修改一些书中的内容。

Use Intention-Revealing Names(使用'顾名思义'的名称)

这个很好理解,在我们写程序的时候,无论变量,函数,参数,类等的名称,都应该遵循这个标准。因为它可以很好地帮助你,或者其他程序员理解你的程序,理解你的变量或代码片段的目的。下面是书中的例子:

public List<int[]> getThem() {
  List<int[]> list1 = new ArrayList<int[]>(); 

  for (int[] x : theList)
   if (x[0] == 4) 
      list1.add(x);
  return list1; 
}

这段代码是干什么的呢?其实细细去读也不难发现这就是将某个list中值为4的数组加入另一个list(其实就是筛选的功能)。但是这样的代码让人很头疼,我在工作中也最烦遇到这样的代码,一般来说,只有很抽象的算法代码才会写成这样。阅读者会对这类代码产生很多问题,例如:

  1. theList到底是干嘛的,包含什么?
  2. x[0]是什么,包含什么?
  3. 4又代表什么?
  4. list1返回后怎么用?

下面是改良版的程序:

public List<int[]> getFlaggedCells() {
  List<int[]> flaggedCells = new ArrayList<int[]>();

  for (int[] cell : gameBoard)
  if (cell[STATUS_VALUE] == FLAGGED) 
         flaggedCells.add(cell);

  return flaggedCells; 
 }

重命名之后,我们可以轻易看出这估计是个(国际)象棋游戏,标记位的cell被取出。

Avoid Disinformation (避免虚假命名)

一言以蔽之就是不要使用那些会混淆代码理解,或者错误的命名。例如不要和系统的关键字重复或特别相近, hp,aix,sco这类的前缀或者变量名不可使用,因为这是UNIX
系统内部名称。还有就是在命名一些特定数据结构时要谨慎,例如你有一对account,你可以命名成 bunchOfAccounts 或者 accountGroup 抑或accounts.书中不建议使用accountList,除非它真的是一个list结构。对此,仁者见仁,智者见智了。因为看你代码的也都是程序员,这样命名个人觉得是可以的,注意不要把Array命名成List。书中还举了一个'awful'的例子,就是用大写的'L'和'O'做变量名,类似hot key。要知道'O'和'0'是很像的,所以轻易不要用。

Make Meaningful Distinctions(命名要做有意义的区分)

不同的变量要用不同的名称区分开来。相信不少同学在命名的时候都用过a1,a2,a3这样的变量名。这并不好。一些noise的数字不应该出现在本应有意义的名称中,因为这样根本体现不出作者的意图。其实呢,在平常写一些测试程序的时候,可以图简便,这样写写。但是到了项目中,一定要用可区分的名称。书中还举到一个例子我觉得很不错, 如下:

getActiveAccount(); 
getActiveAccounts(); 
getActiveAccountInfo();

说实话,我真的不知道用哪个函数来读取账户信息了,这就是典型的区分度做的不够。

Use Pronounceable Names(用能读出来的名字)

这个没什么可说的,上个例子。genymdhms这个变量是干什么的?其实它是代表一种类型的Date,年月日-时秒分,gen代表generate。KK,挺复杂的。改成generationTimestamp就好些了。

Use Searchable Names(使用可搜索的名称)

我们为什么总强调合理的命名呢?为什么要大家都遵循命名的规范呢?其实无非是想形成一个约定俗成的习惯,让大家都能进行标准化的开发罢了。当我接手一个项目,当我想找网络模块某个功能的时候,我会去想之前的developer会用什么名字命名,例如login部分,register部分等等。这也方便之后的人去查找代码位置。但如果你命名了一个a3, b4,那查找起来就很吃力了。原书中的例子是:MAX_CLASSES_PER_STUDENT和7哪个好查找?不用说,当然是第一个。

Avoid Encodings(避免编码化命名)

这个其实遇到的情况不多,除非你是写底层的(Windows C API). 编码化命名指的是在name中加入数字,范围等信息的命名方式。最典型的就是匈牙利命名法。这种命名需要每个新加入的成员好好学习上一番,而且需要更长时间来适应它。具体的匈牙利命名是怎么回事就不在这里多说了,大家可以看这里

Avoid Mental Mapping(避免心理地图式命名)

每个程序员都有可能使用一些shortcut(快捷方式)来命名一些长些的名称,例如用r代替url, co代替commit等等。这种命名当然不好,在项目中不要用。

Class,Method Names(类和方法的命名)

类命名要用名词性质的词,例如Customer, WikiPage,而且第一个字母要大写。原书中说道类名中不要出现动词,例如Manager, Processor, Data, 但个人觉得此条并不能让我信服。举例来说,GFTRequestManager可以让我很快意识到这是一个控制网络请求的单例控制类,而且不会和XXXRequest(某个特定请求)重复。至于函数名称,基本要包含动词了,例如postNotification这些。

Don't be cute and pun(别犯傻和用双关语)

不要使用你自己觉得很可爱其实很傻的命名,例如HolyHandGrenade, 老老实实用deleteItems代替。双关语就不多说了,别让人理解错就行。

剩下的部分就是告诉我们也可以添加一些context帮助理解,例如注释,不过不要让你的注释成为累赘,必要的时候再添加。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,711评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,079评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,194评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,089评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,197评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,306评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,338评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,119评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,541评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,846评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,014评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,694评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,322评论 3 318
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,026评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,257评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,863评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,895评论 2 351

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,644评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,914评论 25 707
  • 1. 简介 1.1 什么是 MyBatis ? MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的...
    笨鸟慢飞阅读 5,474评论 0 4
  • 第一部分 打好基础 Laying the Foundation 第一章 欢迎进入软件构建的世界 Welcome t...
    白桦叶阅读 4,615评论 0 17
  • 独步天下。
    杏林骨怪阅读 274评论 0 0