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

重要性

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

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

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

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

借鉴英语的做法

大小写问题

自带主角光环,C位出道

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

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

缺陷

空格在这里不好使了

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

补救

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

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

形成风格

超级专有名词

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

有人的地方,就有江湖

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

人以类聚,物以群分

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

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

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

代码之外

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

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

好的实践

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

TBC

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

你可能感兴趣的:(有效掌握编程风格 - 命名规范)