代码整洁之道—变量名

软件中随处可见命名,我们给变量,函数,参数,类,包。给源代码及源代码目录命名,给jar文件,war文件,ear文件命名,我们命名,命名,不断命名。既然有这么多命名,那么我们就有必要做好它。

选个好名字要花时间,但是节省下来的时间比花掉的多。注意,一旦有好的命名,就要替换掉原本旧的名称。认真对待每个变量名,你当用自己第一个孩子般的谨慎给变量命名。

给变量命名是开发的基础,看起来是小事,然成败在于细节之中,不要忽视它的重要性。

基本的命名法则

  • 不要定义一些与系统名称相冲突的变量名,比如定义数据库的order字段会报错。
  • 不要定义太长的变量名,比如XYZControllerForEfficientHandingOfStringsXYZControllerForEfficientStorageOfStrings区分起来的麻烦
  • 类名一般是名词,方法名一般是动词
  • 避免留下掩盖代码本意的错误线索,避免使用与本意相悖的词。
  • 尽量见名知意

做有意义的区分

废话是一种没意义的区分,假设你有一个Product类,如果还有一个ProductData和ProductInfo类,它们的名称虽然有区别,但是意思却无区别,info和data就像a,an和the一样,是意义含混的 废话。

如果缺少明确约定,变量moneyAmount就与money没区别,cusomerInfo与customer没区别,accountData与account没区别,theMessage与message没区别,要区分名称,就要以读者能鉴别不同之处的地方区分。

每个概念对应一个词

比如fetch,get,retrieve代表的都是获得的意思,但是如果在表达获得的时候三者混着使用,在当前文件的获得使用的是get,下个文件获得使用的是fetch,这样就容易造成混淆。

假设其余人看到你的程序,若同一个概念你使用的是同一个词,那么对自己对他人都是一种帮助。

避免思维映射

不要让读你代码的人把你所命名的变量在头脑中转换为另外一种概念。

单字母变量就是个问题,在作用域小,也没有名称冲突时,循环计数器,自然有可能被命名为i,j,k,这是因为传统上惯用单字母名称做循环计数器。
然而在多数情况下,单字母名称不是个好的选择,读的人必须要把它在脑中转换为真实的概念。

在你使用单字母做为变量的时候,在搜索这个名称的时候就出现了问题, 太多单词都会包含你所定义变量名的字母。

普通聪明程序员和专业程序员的区别在于,专业程序员了解到,明确才是王道

语境

添加有意义的语境,不要添加没有意义的语境。

设想你有名为firstName、lasiName、street、houseNu田ber、city·state和zipcode的变量。当它们在一块儿的时候,很明确是构成了一个地址。不过,如果只是在某个方法中看见孤零零一个state变量昵?你会理所当然推断那是某个地址的一部分吗?

可以添加前缀addrFirstName、addrLastName、addrstate等,以此提供语境。至少,读者会明白这些变量是某个更大结构的一部分。当然,更好的方案是创建名为Address的类。这样,即便是编译器也会知道这些变量隶属某个更大的概念了。

所谓不要添加无意义的语境,当你的名字也许短小,但是足够清楚的表达你想表达的意思的时候,就无需添加额外的语境。

Address是个好名称,不过若与Mac地址,端口地址,Web地址区别,可以考虑使用PostalAdress,MAC,URI来区别,因为大家虽代表的是地址,但意思上还是有区别的。

最后

这里没有展示案例,纯理论看起来理解起来相对费力一些,建议购买《代码整洁之道》

让自己的代码更好,通往编程大神之路。

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,594评论 18 139
  • 阅读《代码整洁之道》有两种原因,第一种:你是个程序员;第二,你想成为更好的程序员。读完后,你能获得如下技能: 知道...
    清风流苏阅读 1,028评论 0 2
  • 眼下半开的桔梗花美得如此妖治,一半永恒一半无望,双重含义下,是你永远读不懂的殇。 ——题记 墨莲,老路笔下...
    十点树洞先生阅读 3,471评论 4 8
  • 尤其记得小升初后下乡的那段时间,改变了我很多,变成了一个小流氓。等待出成绩的假期是漫长的,也是筹措不安的,...
    想要起飞的懒癌患者阅读 231评论 0 0
  • 我终于 入了 滴胶 大坑! 凝固之后效果真的好好看,虽然中途各种被我弄倒(阿扎心!心疼我的胶! 等待凝固的时间多么...
    羽良奈奈绪阅读 490评论 0 0