有意义的命名

有意义的命名.png

名副其实

  1. 选个好名字要花时间,但省下来的时间比花掉的多。
  2. 一旦发现有更好的名称,就换掉旧的。
  3. 好的名称会告诉你:它为什么会存在,它做什么事,应该怎么用。

避免误导

  1. 应该避免留下掩藏代码本意的错误线索。应当避免使用与本意相悖的词。
  2. 不要在名称中写出容器类型名。可以用group或bunchOf或者加s。
  3. 提防使用不同之处较小的名称。
  4. 以同样的方式拼写出同样的概念才是信息。拼写不一致就是误导。

误导产生问题原因:程序员大多数时候根本不看详细注释;用IDE的快速搜索功能的时候会因为命名差距较小出现一堆无用的结果。

做有意义的区分

  • 不要使用相近含义的单词,例如:ProductData,ProductInfo,这里Info和Data就是意义含混的废话。
  • 废话是冗余,例如:nameString,这里name难道会是一个浮点数不成。

使用读得出来的名称

如果名称读不出来,讨论的时候就像个傻鸟。

使用可搜索的名称

  • 不要使用单字母名称数字常量。很难在一大篇文字中找出来。因此长名称胜于短名称,搜得到的名称胜于用自造编码代写就的名称。
  • 单字母名称仅用于短方法的本地变量,名称长短应与其作用域大小相对应。若变量或常量可能在代码中多处使用,则应赋其以便于搜索的名称。

避免使用编码

  • 编码已经太多,不要在代码逻辑中又增加一种编码“语言”。
  • 带编码的语言不利于发音,容易打错。

匈牙利语标记法:现代编程语言具有更丰富的类型系统,编译器记得并强制使用类型。而且,人们趋向于使用更小的类、更短的方法,好让每个变量的定义都在视野范围之内。
成员前缀:应当把类和函数做的足够小,消除对成员前缀的需要。使用某种可以高亮或用颜色标出成员的编译环境。
接口与实现:我不想让用户知道我给他们的是接口。如果接口和实现必须选一个来编码,选实现,加Impl。

避免思维映射

不要让读者在脑海中把你的名称翻译为他们熟知的名称。这说明你起的名称不够明确

类名

名词或名词词组

方法名

  • 动词或动词词组。
  • 属性访问器、修改器和断言应该根据其值命名,并依JavaBean标准加上get、set和is前缀。
  • 重载构造器时,使用:描述了参数的静态工厂方法名,将相应的构造器私有化,强制使用这种命名手段。

别扮可爱

你的幽默、文化背景,别人可能不懂。

每个概念对应一个词

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

别用双关语

避免将同一单词用于不同目的。

使用解决方案领域名称

只有程序员才会读你的代码。所以,尽管用程序员都懂的术语。依据问题所涉领域来命名会让协作者总是跑去问客户每个名称的含义。

使用源自所涉问题领域的名称

这是在上一条无法使用的时候,才去使用的办法,至少负责维护代码的程序员能去请教领域专家。

优秀的程序员和设计师,其工作之一就是分离解决方案领域和问题领域的概念。与所涉问题领域更为贴近的代码,应当采用源自问题领域的名称。

添加有意义的语境

如果前面的都不好使了,给名称添加前缀就是最后一招了。当然更好的方案是创建一个类把字段封装进去,这样就提供了语境了。

不要添加没用的语境

只要短名称足够清楚,就要比长名称好。别给名称添加不必要的语境。精确是命名的要点。不要搞到:输入G,按下自动完成键,结果会得到系统中全部类的列表,列表恨不得有一公里那么长。这样搞的IDE都没法帮助你!!!

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

推荐阅读更多精彩内容