一、代码整洁之道:命名

1.名副其实

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

int d;// 消逝的时间,以日计

名称d什么野没说明,他没有引起对时间消逝的感觉,更别说以日计。
我们应该指明计量对象和计量单位的名称:

int elapsedTimeInDays;
int daysSinceCreation;
int daysSinceModification;
int fileAgeInDays;

2.避免误导

程序员必须避免留下掩藏代码本意的错误线索。应当避免使用与本意相悖的词。

别用accountList来指称一组账号,除非它真的是List类型。List一词对程序员有特殊意义。

提防使用不同之处较小的名称。

XYZControllerForEfficientHandlingOfString 和另一处 XYZControllerForEfficientStorageOfString ,区分起来会很花时间。

3.做有意义的区分

如果程序员只是满足编译器或解释器的需要而写代码,就会制造麻烦。

例如,因为同一作用范围内两样不同的东西不能重名,你可能会随手改掉其中一个的名称。有时干脆以错误的拼写充数,结果就是现在更正拼写后导致编译器出错的情况。

public static void copyChairs(char a1[],char a2[]) {
   for(int i = 0, i < a1.length, i ++) {
        a2[i] = a1[i];
   }
}

如果修改名称为source和destination,这个函数就会像样许多。
废话是另一种没有意义的区分。假如你有两个Product类,还有一个叫ProductInfo 或者 ProductData 类,那他们的名称虽然不一样,意思却无区别。

4.使用读得出来的名称

人类长于记忆和使用单词,名称读不出来,感觉就是沟通困难。

有家公司,程序里面写了一个 genymdhms(生产日期,年、月、日、时、分、秒),他们一般读作“gen why emm dee aich emm ess”即字母的读音,有见字读音的习惯就会读成“gen-yah-mudda-hims”。后来人根本不知道这个名词的意义。这是自造词,而非恰当的英语词。

class DtaRcrdl02 {
  private Date genymdhms;
  private Date modymdhms;
  private final String pszqint = "102";
 ...
};
class Custmer{
   private Date generationTimestamp;
   private Date modificationTimestamp;
   private final String recordId = "102";
 ...
}

5.使用可搜索的名称

单字母名称和数字常量有个问题,就是很那在一大篇文字中找出来。

找MAX_CALSSES_PER_STUDENT 很容易,找到一个数字7就很困难了。

6.避免使用编码

编码已经太多,无畏再自找麻烦。

把类型或作用域编进名称里面,徒然增加了解码的负担。带编码的名称也不方便发音,容易打错。

PhoneNumber phoneString;// 类型变化时,名称并不变化

有时会出现采用编码的特殊情形。比如,你在做一个创建形状的抽象工厂(AbstractFactory)。该工厂是个接口,要用具体的类来实现。怎么命名呢?IShapeFactory 和 ShapeFactory 吗?肯定ShapeFactory。前缀字母I被滥用,说好听是干扰,说难听点就是废话的程度。

7.避免思维映射

不应当让读者在脑中把你的名称翻译成他们熟知的名称。明确是王道。

8.类名

类名和对象名应该是名词,不应当是动词

如 Custmer,WikiPage,Account等,避免使用Manager、Processor、Data或Info这样的类名。

9.方法名

方法名应当是动词或动词短语,postPayment、delegatePage、save。属性访问器加上get、set和is前缀。

10.每个概念对应一个词

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

11.别用双关语

避免将同一单词用于不同的目的。同一术语用于不同的概念,基本就是双关语了。

12.添加有意义的语境

很少有名称是能自我说明的--多数都不能。反之,你需要用有良好命名的类、函数或名称空间来设置名称,给读者提供语境。

13.不要添加没用的语境

只要短名称足够清楚,就要比长名好。别给名称添加不必要的语境。

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