代码整洁之道:有意义的命名

名副其实

  1. 如果名称需要注释来补充,那就不是名副其实
  • bad
int d; // 消逝的时间,以日计
  • good
int elapsedTimeInDays;
int daysSinceCreation;
int daysSinceModification;
int fileAgeInDays;

避免误导

  1. 别留下掩藏代码本意的错误线索
  • bad
    accoutList
    除非它真的是List类型
  • good
    accountGroup
    bunchOfAccounts
    accounts
  1. 提防使用不同之处比较小的名称
    对于
    XYZControllerForEfficientHandlingOfStrings
    XYZControllerForEfficientStorageOfStrings
    难以分辨
  2. 避免使用小写字母l和大写字母O作为变量名

做有意义的区分

  1. 避免光是添加数字
  • bad 以数字系列命名
    (a1、a2 .... aN)完全没有提供有效信息,没有提供导向作者意图的线索
public static void copyChars(char a1[], char a2[]){
  for (int  i = 0; i<a1.length; i++)
    a2[i]  = a1[i];
  }
}
  • good
    a1 -> source
    a2 -> destination
  1. 避免以废话命名
  • bad
    已经有一个Product类,如果还有一个ProductInfo类 或 ProductData类,虽然名称不同,但意思却没有区别,Info和Data是意义混淆的废话

使用读得出来的名称

  1. 使用可读的单词做命名,而不是自造不可读的词
  • bad
class DtaRcr102 {
  private Date genymdhms;
  private Date modymdhms;
  private final String pszqint = "102";
};
  • good
class Customer {
  private Date generationTimestamp;
  private Date modificationTimestamp;
  private final String recordId = "102";
};

使用可搜索的名称

  1. 单字母名称和数字常量会很难在一大篇文字中找出来
  2. 长名称胜于短名称
  3. 名称长短应与其作用域大小相对应,单字母名称仅用于短方法中的本地变量
  • bad
for (int j=0; j<34; j++) {
 s += (t[j]*4)/5;
}
  • good
int realDaysPerIdealDay = 4;
const int WORK_DAYS_PER_WEEK = 5;
int sum = 0;
for (int j=0; j < NUMBER_OF_TASKS; j++) {
  int realTaskDays = taskEstimate[j] * realDaysPerIdealDay;
  int realTaskWeeks = (realdays / WORK_DAYS_PER_WEEK);
  sum += realTaskWeeks;
}

避免使用编码

  1. 不宜用m_前缀标明成员变量,应当用某种可以高亮或用颜色标出成员的编辑环境

避免思维映射

  1. 不应当让读者在脑中把你的名称翻译为他们熟知的名称。例如i,j,k常被用于循环计数中,而不适合用于别的场合

类名

  1. 类名和对象名应该是名次或名词短语,如Customer、WikiPage、Account
  2. 避免Manager、Processor、Data或Info这样的类名。

方法名

1.方法名应当是动词或动词短语,如postPayment、deletePage或save

  1. 属性访问器、修改器和断言应该根据其值命名,并加上get、set、is的前缀
  • good
string name = employee.getName();
customer.setName("mike");
if (paycheck.isPosted())...

3.重载构造器时候,使用描述了参数的静态工厂方法名

  • bad
Complex fulcrumPoint = Complex.FromRealNumber(23.0);
  • good
Complex.fulcrumPoint  = new Complex(23.0);

别扮可爱

  • bad
HolyHandGrenade
  • good
DeleteItems

每个概念对应一个词

  1. 给每个抽象概念选一个词
  • bad
    fetch、retrieve、get

别用双关词

使用解决方案领域名称

  1. 用程序员熟悉的术语命名

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

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

添加有意义的语境

  1. 用有良好命名的类、函数或名称空间来放置名称,给读者提供语境
  2. 如果1做不到,那就给名称添加前缀。
  • bad
firstName
lastName
street
houseNumber
city
state
zipcode
  • good
addrFirstName
addrLastName
addrState...
或者是创建名为Address的类

不要添加没用的语境

  • bad
    有一个名为“Gas Station Deluxe”的应用,然后给每个类加GSD前缀

这样会得到系统中全部类的列表,冗长得无法选择

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,599评论 18 139
  • 一、整洁代码 A.混乱的代价 1.有些团队在项目初期进展迅速,但有那么一两年的时间却慢去蜗行。对代码的每次修改都影...
    ZyBlog阅读 2,017评论 0 2
  • 第一部分 打好基础 Laying the Foundation 第一章 欢迎进入软件构建的世界 Welcome t...
    白桦叶阅读 4,600评论 0 17
  • 软件中随处可见命名 ,我们给变量、函数、参数、类和封包命名。我们给源代码及源代码所在的目录命名,既然有这么多命名要...
    gg大宇阅读 219评论 0 0
  • —有的时候,我能清晰地感觉到有什么东西在我的心上划过了,它叫无能为力。— 你是否也有过这样的经历,别人无意间的一句...
    嫣然子阅读 224评论 0 0