第二章 有意义的命名

2.2 名副其实

  1. 在代码中体现上下文的语境,能够知道这段代码想干什么;

2.3 避免误导

  1. 避免留下隐藏代码本意的线索;
  2. 提防使用不同之处较小的名称;
  3. 以同样的方式书写同样的概念才是信息;

2.4 做有意义的区分

  1. 在变量后面添加数字来做区分和说废话没有任何区别;
  2. 废话永远都是冗余,Variable一词永远不应当出现在变量中,而Table一词永远不要出现表名中;
  3. 要区别名称,就要以读者能鉴别不同之处的方式来做区分;

2.5 使用读得出来的名称

2.6 使用搜索得出来的名称

  1. 单字母名称仅用于短方法中的本地变量。
  2. 名称长短应与其作用域大小相对应。
  3. 若变量或常量可能在代码多处使用,则应赋其以便于搜索得名称。

2.7 避免使用编码

  1. 将类型和作用域带进名称里面,增加了解码的负担;
  2. 匈牙利标记法,成员前缀或后缀,接口和实现;

2.8 避免思维映射

  1. 不应让读者把你的名称翻译为他们脑中熟知的名称;
  2. 专业程序员了解,明确才是王道;

2.9 类名

说明:类名和对象名应该是名词或者名词短语,避免使用Manager、Data、Info这样的名称,不使用动词。

2.10 方法名

说明:方法名使用动词或动词短语,重载构造器时,使用带参数的静态工厂方法名。

2.11 别扮可爱

2.12 每个概念对应一个词

说明:给每个抽象概念选一个词,并一以贯之,明确对概念的一致认识有助于迅速找到正确的名称。

2.13 避免使用双关语

  1. 避免将同一单词用于不同目的;
  2. 代码作者应尽量写出易于理解的单词

2.14 使用解决方案领域名称

说明:多使用专业的术语,因为毕竟只有程序员才会看你的代码,给某些事取一个技术性的名字,是最靠谱的做法。

2.15 使用源自问题领域的名称

说明:优秀的程序员和设计师,其工作之一就是分离解决方案领域和问题领域的问题。

2.16 添加有意义的语境

  1. 你需要有良好的类、函数或名称空间来放置名称,为读者提供上下文的语法;
  2. 算法能够通过分解为更小的函数使语境增强,从而显得干净利落;

2.17 不要添加没有必要的语境

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

2.18 最后的话

说明:取好名字最难的地方在于需要良好的描述技巧和工友的文化背景。

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

推荐阅读更多精彩内容