Clean Code第二章:有意义的命名 --阅读与讨论

本章,作为整洁代码的头一步,致力于规范命名规则。

names.png

图片来自<Clean Code>

所谓名不正则言不顺,命名的好,代码可读性一下子就可以提高一大块。

本章讲解了十多种命名时的注意事项。

提到命名,使我想起谭浩强先生的书,我是从他的C语言编程书入门的。

虽说编程语言入门了,可那时养成了一些非常不好的编程习惯,给变量随便命名,就是其中一种。

随便摘一段该书中的代码:

<pre>
long f1(int p)
{
int k;
long r;
long f2(int);
k=p*p;
r=f2(k);
return r;
}
</pre>

除了仔细看代码外,基本看不出来该函数在干什么。

如果动辄几万行,几十万行的项目是这么命名,完全是惨不忍睹啊!

一, 命名要名副其实

如果命名还需要注释,那么该命名则是不合理的:
<pre>
int d; // elapsed time in days
</pre>

以下命名是合适的:
<pre>
int elapsedTimeInDays;
int daysSinceCreation;
int daysSinceModification;
int fileAgeInDays;
</pre>

命名增加了可读性,例如如下代码,看起来就不知所云:
<pre>
public List<int[]> getThem() {
List<int[]> list1 = new ArrayList<int[]>();
......
for (int[] x : theList)
if (x[0] == 4)
list1.add(x);
return list1;
}
</pre>
而如果是改成下面的两种,代码则清晰很多:
<pre>
public List<int[]> getFlaggedCells() {
List<int[]> flaggedCells = new ArrayList<int[]>();
......
for (int[] cell : gameBoard)
if (cell[STATUS_VALUE] == FLAGGED)
flaggedCells.add(cell);
return flaggedCells;
}
</pre>
或是
<pre>
public List<Cell> getFlaggedCells() {
List<Cell> flaggedCells = new ArrayList<Cell>();
......
for (Cell cell : gameBoard)
if (cell.isFlagged())
flaggedCells.add(cell);
return flaggedCells;
}
</pre>

二, 避免误导

请避免使用与本意相混淆或相悖的词。

例如,aix,sco,hp,不该作为变量名,因它们都是UNIX平台上的专有名称。

除非是List类型,否则不要用类似accountList来命名一组账号,可以命名为accountGroup。

1和l,O和0很容易混淆,请注意使用。

三,有意义的区分

例如,ProductInfo和ProductData就没有意义上的区别,很容易混淆。

废话都是冗余的,例如Variable用于变量名中,Table用于表名中。

四,使用读得出来的名称

命名尽量别缩写,时间长了谁都看不懂了。

以下命名,对比一下,哪个更容易读明白:
<pre>
class DtaRcrd102 {
private Date genymdhms;
private Date modymdhms;
private final String pszqint = "102";
/* ... /
};
</pre>
<pre>
class Customer {
private Date generationTimestamp;
private Date modificationTimestamp;
private final String recordId = "102";
/
... */
}
</pre>

五,使用可搜索的名称

如果变量可能在代码中多处使用,则应赋以便于搜索的名称。变量作用域越大,越需要精心命名以便搜索。

例如,如果一星期5天的“5”经常被使用,则将其命名为WORK_DAYS_PER_WEEK要比“5”好搜索的多。

六,尽量避免使用编码和成员前缀等“旧时代”规则

例如,匈牙利标记法,成员前缀(m_dsc等等)。现在的编程里,这种前缀和标记法的命名方法越来越少见了。

例如,抽象工厂及其实现,

可以写成:IShapeFactgory和ShapeFactory,

也可以写成ShapeFactory及ShapeFactoryImp.

作者推荐后者的写法。

七,避免思维映射

尽量别用脑中熟悉的缩写,来取变量名。

例如,i在编程人员眼中,经常代表index.但最好用当时有意义的名称来替代i.

八,类名

类名应当是名词或名词短语,例如Customer,WikiPage,AddressParser。

请避免用太通用的Data,Info等词。

类名不应该是动词。

九,方法名

方法名应该是动词或动词短语,例如:postPayment,deletePage或者save.

如果是属性访问,则加上"get","set","is"等前缀。

十,别扮可爱(卖萌)

别用俗语来做名称。

例如whack()来表示kill()等。

十一,每个概念对应一个词

请给每个抽象概念选一个词,并一以贯之。

例如,如果fetch,retrieve,get并列出现在方法名里,你怎么知道用哪个?

Controller和Driver,Manager也是令人困惑的一组词。

十二,别用双关语

请避免同一术语用于不同概念。例如,add方法,如果用于collection时,则应该叫append或insert更贴切。

十三,使用计算机科学领域的名称还是问题域的名称

如果能用计算机科学领域的术语,则尽量使用。因只有程序员才会读你的代码。

例如,AccountVisitor,程序员一看就知道这是访问者模式。

如果不能用程序员所熟悉的术语,则采用所涉问题领域来的名称。

至少,看到该名称,能联想到去找该领域专家来询问所需知识。

十四,添加有意义的语境

看到一个state变量,可能不知道它是什么意思,但如果是addrState,很容易看出它是地址的一部分。

如果state是Address类的成员,含义就更清晰了。

十五,不要添加没意义的语境

例如,给每个类添加一个全局前缀,一般都没有意义。因为所有的类都有此前缀,则变成了没有区别。

问题:

1,你所写过,改过或看过的代码中,有哪些是命名很糟糕的,请举例。

2,有哪些是命名很不错的,也请举例。

3,此章中命名的规范里,哪些是你已经遵守了的规则,哪些是你忽略了的?

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

推荐阅读更多精彩内容