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

       在日常编程中,命名是随处可见的,比如变量名、函数名、参数名、类名、包名,在这几年的编程过程中,看过很多类型的命名,开源的和同事的,风格各异。一个好的命名可以让人有一个很好的代码阅读感受,减少别人阅读的困难,提升阅读代码的效率。这次讲讲我遇到过的一些不好的命名以及如何更好地命名。

       一、用合适的命名代替注释

      有一次,看到一个同事的代码写的是

int t; // timestamp for recording data

       这里的t后面加了注释-记录数据的时间戳,在下面的代码中我也大概能记得这个t的含义,但是当我过几天去看这段代码的时候,我就忘记这个t的含义了,我要找回这个定义处的注释,才得知这个变量的含义,十分的麻烦,因为t可能指的是一段时间time,也有可能是指timestamp时间戳,也有可能是业务里某个以t开头的单词。如果不是自己写的,真的很难看一眼就知道含义,那为什么不使用一个更合适的命名呢?这样不仅不需要在后面写注释,更可以让后面用到该变量的时候一眼就可以看的出来。

       在我以前的后端编程中,时长我经常用duration这个变量来表示,但是存在一个问题,就是这个单位总是和前端的两个同事(安卓开发和iOS开发)搞混,一个觉得是以秒为单位,一个是以为以分钟为单位,经常容易出现问题,后面我把时长改成了durationInMin或者durationInSec,这样我们前后台联调的效率就高了很多,不会因为单位的问题调试半天。因此在编程中一定要使用合适的命名。

        二、做有意义的区分

        之前我在同事的代码里面看到一段关于字符串处理的函数,把字符数组赋值给另外一个字符数组,他是这样写的:

public static void copyChars(char a1[], char a2[]) {

   for (int i = 0; i < a1.length; i++ ){

         a2[i] = a1[i];

   }

}

       这一段代码看着特别的简单,把a1的所有元素通过for循环依次赋值给a2,但是这样的命名在代码中多了,就会显得特别的乱,在代码中我们还是尽量避免这样的命名,把a1改成source,把a2改成destination,这样函数看起来就会更有意义。

       还是就是,假如有一个Product类,如果还有一个名为ProductInfo或者ProductData的类,这样显然是没有太大的意义,表达的意思都是同一个。另外我还发现,有些同事喜欢写xxxStr,这个变量还一定是字符串变量,比如nameStr,这就让我很疑惑了,难道name还能是数值类型的?nameInt?显然这样的命名也是没有意义的,直接写一个name不是更香吗?

      对于函数来说,比如我有3个函数分别是:

getActiveAccount();

getActiveAccounts();

getActiveAccountInfo();

      当我需要获取活跃用户的账户时,我该调用哪个函数呢?是不是会一脸懵逼?所以当我们在命名的时候,一定要注意命名要有意义,这样使用起来才会更加方便。

 三、命名风格要统一

       我在以前一个大项目中,由于参与的开发同事特别多,所以在代码里,我既可以看到xxxController,也可以看到xxxManager,还有一些地方看到xxxDriver,但仔细看他们的代码,都是类似的逻辑实现部分,相当于MVC里面的C。当一个项目中含有这三种命名的时候,人的第一感觉是不同类型的名字,所以特别的不好,一个项目应该使用统一的命名,要不就统一使用xxxController,要不就统一使用xxxManager,或者统一使用xxxDriver。

       同样的,由于有些方法是添加一个元素到数组中,有些人用的是insert,有些人用的是add,有些人用的是append,这样在做全局搜索的时候特别麻烦,搜索insert的时候,add和append无法搜索的到。因此,在写这些有多种表达的变量名的时候,我们需要更多地去阅读之前的代码,和其他的风格保持一致,尽量让其他人不会看得出代码是由不同的人写出来的。

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

推荐阅读更多精彩内容