做有意义的命名

软件中随处可见命名。我们给变量、函数、参数、类和封包命名。我们给源代码及源码所在的目录命名。我们给 jar 文件、 war 文件 和 ear 文件命名。有很多命名要做、不妨做好它。下面列出几条简单规则。

1. 名副其实

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


2. 避免误导

  1. 避免留下掩藏代码本意的错误线索。
    例如:使用某些专有名词作为变量名,使用缩写。
  2. 避免使用与本意相悖的词
    例如:
    String[] accountList = new String[10]; accountList 实质是一个数组对象,命名后缀为
    List产生误导作用。
  3. 避免使用外形相似的命名
    例如:两个变量
  4. 避免使用小写字母 l 与 大写字母 O 作为变量名,跟数组1 和数字 0 难以区分。

3. 做有意义的区分

如果只是为了满足编译器或解释器的需要而写代码,肯定会制造麻烦。

错误示例:

1. 添加数字系列,这样的名称纯属误导。

  • 例如:
    定义两个学生对象
    Student student1 = new Student();
    Student student2 = new Student();

2. 少使用废话,废话都是冗余。要区分名称,要以读者能鉴别之处来区分。

  • 例如:假设已有一个 Product 类,还有ProductInfo 类 和 ProductData 类,虽然名称不同,意思却无差别。 Info 和 Data 就i想 a、an、the 一样,都是意义含混的废话。

  • 例如:如果你需要获取账户信息,你该调用那个方法呢 ?
    getAccount();
    getAccounts();
    getAccountInfo();

  • 例如:
    moneyAmount 和 money 没区别,
    customerInfo 与 customer 没区别,
    accountData 和 account 没区别,
    theMessage 和 message 没区别 。


4. 使用读的出来的名称

错误示例:

1. 使用汉语拼音,只会让别人觉得你写的代码很 low.

2. 使用罕见的英语词汇


5. 使用可搜索的名称

建议:

1. 使用长名称,长名称胜于短名称。

  • 例如: WORK_DAYS_PER_WEEK 比数字 5 好找得多。

6. 避免使用编码

编码已经太多,不需要自找麻烦。


7. 避免使用前缀

不必使用 m_ 前缀来表名成员变量,很多时候阅读代码的人不会去看前缀,直接看后面有意义的名称,前缀反而成了废代码。


8. 接口和实现


9. 类名

类名和对象名应该是名词或者名词短语,不应该是动词。

  • 正例:Customer
  • 反例:CustomerInfo、CustomerData、 Data .

10. 方法名

方法名应该是动词或者动词短语,不应该是名词。

  • 例如:getName(); setName() 等。

11. 避免思维映射

  • 例如:变量 i、j 通常用于 for 循环中,传统惯用这种单字母名词作为循环计数器,并不是一种好的选择。

12. 避免使用双关语

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

推荐阅读更多精彩内容

  • 1、引言 数据库设计过程中表、字段等的命名规范也算是设计规范的一部分,不过设计规范更多的是为了确保数据库设计的合理...
    SnowflakeCloud阅读 40,988评论 0 48
  • 前言 说是前言,其实也是本文诞生的目的。随着公司业务的不断增加,功能的快速迭代,app的业务线越来越多,代码体积变...
    Yealink阅读 5,306评论 0 13
  • Swift1> Swift和OC的区别1.1> Swift没有地址/指针的概念1.2> 泛型1.3> 类型严谨 对...
    cosWriter阅读 11,097评论 1 32
  • 趁着这些日子有些许时间,把之前看的书做了读书笔记,并重新复盘。 《新员工的差距是怎样拉开的》 这是一本日本作者的书...
    梵曦FANXI阅读 119评论 0 0
  • 今天下午我们做月饼了,老师给我们讲了月饼的来历,古时候,皇帝非常欺负老百姓,有一个人,想把聪明人招集起来。但是...
    韩梦荧阅读 142评论 0 0