有效掌握编程风格 - 命名规范

重要性

无名,天地之始,有名,万物之母。

我们先试着分析一下代码的构成,

  • 关键字,由语言的语法所定义,一般都是很短的词
  • 运算符,也由语法所定义,有的语言允许修改其功能,但大部分不允许
  • 标识符,这是编程时可以自由发挥的地方,也是代码占比最大的部分

由此可以看出,占比最大的标识符的命名,是代码可读性的头号玩家

借鉴英语的做法

大小写问题

自带主角光环,C位出道

英语写作中默认都是小写,只在需要强调的地方使用大写,如句首字母要大写,专有名词也大写。基本上大写出现的地方,要不是作为主角,要不是处于关键位置;对大写识别的敏感性也近乎成为人的本能。
在代码中,

  • 相当于专有名词的有:源码组织级别的名称--模块名/包名、类名
  • 相当于句首的有:函数名/方法名,更严格一点说是公有的
    剩余的,还有表达式、变量等,保持小写即可。

缺陷

空格在这里不好使了

标识符不能包含空格,这是“历史遗留问题”,这导致不能用一个单词表达意思的标识符,都必须通过连接多个单词的方式进行组合。

补救

总不能几个单词直接连在一起吧?
果然,像thisisaname这样的命名法,人神共愤,被各家所抛弃。
那剩下就只有两个方向:

  • 单词首字母大写
    由于不增加任何连接符号,尤受各家追捧
  • 使用别的符号充当空格来连接单词
    出于的考虑,一般只限定使用下划线_来充当连接符

形成风格

超级专有名词

单词首字母大写,相当于把每个单词专有化,然后连接在一起做为一个整体--标识符。以其在代码中的地位来说,也受得起超级专有名词的称号,当然中编程风格界人家是有流派的,叫驼峰命名法

有人的地方,就有江湖

前面说了,标识符在代码中占了大部分,数量多了,总会有要找点不同出来。

人以类聚,物以群分

很快,就有人发现标识符管理的性质存在差异:

  • 有的管事,而且一般只管一件事
  • 有的管人,而且一般管不止一个

于是,管人为凸显自己的优越性,管自己叫大驼峰,把管事的叫小驼峰

代码之外

鲜花很美,有了绿叶的衬托更美

代码做为鲜花是容不下下划线连接单词这种天生缺陷,而且也没有可以叫得出名字的风格,于是将其给了绿叶
主要用于代码的组织,如命名库(libraries)、包(packages)、目录(directories)和源文件(source files)上。

好的实践

  • 职责
    同一名称有多个职责时,加上职责名称以区分
  • 形容词 able

TBC

有效掌握编程风格 - 问题所在

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

推荐阅读更多精彩内容

  • 1、引言 数据库设计过程中表、字段等的命名规范也算是设计规范的一部分,不过设计规范更多的是为了确保数据库设计的合理...
    SnowflakeCloud阅读 40,974评论 0 48
  • 1.Resource文件 命名 遵循前缀表明类型的习惯,形如type_foo_bar.xml。如:fragment...
    Rave_Tian阅读 4,373评论 0 1
  • 1 前言 这份文档是Google Java编程风格规范的完整定义。当且仅当一个Java源文件符合此文档中的规则,我...
    黑鼠_DEAN阅读 1,170评论 0 1
  • Android编码规范 源文件基础 文件名 源文件以其最顶层的类名来命名,大小写敏感,文件扩展名为.java。 文...
    呼呼哥阅读 938评论 0 0
  • 一个统一的编程风格不但能够增强代码可读性,也可以避免许多低级问题。一个严格遵从编码规范的团队,代码无论出自多少人之...
    七弦桐语阅读 621评论 0 2