课程咨询: 400-996-5531 / 投诉建议: 400-111-8989
认真做教育 专心促就业
编程规范性是我们在学习软件编程开发技术的时候需要遵守的一个基本要求,而本文我们就通过案例分析来简单了解一下,编程命名规范都有哪些要求。
代码元素包括类、方法、参数、常量、变量等程序中的各种要素。合适的命名,可以体现出元素的特征、职责,以及元素之间的差异性和协同性。为了统一代码风格,元素的命名要遵守以下约定。
命名符合本语言特性
当前主流的编程语言有50种左右,分为两大阵营—面向对象与面向过程,但是按变量定义和赋值的要求,分为强类型语言和弱类型语言。每种语言都有自己的独特命名风格,有些语言在定义时提倡以前缀来区分局部变量、全局变量、控件类型。比如Ii_count表示localint局部整型变量,dw_report表示datawindow用于展示报表数据的控件。有些语言规定以下画线为前缀来进行命名。这些语言的命名风格,自成一派,也无可厚非,但是在同种语言中,如果使用多种语言的命名风格就会引起其他开发工程师的反感。比如,在Java中,所有代码元素的命名均不能以下画线或美元符号开始或结束。
命名体现代码元素特征
命名上可体现出代码元素的特征,仅从名字上即可知道代码元素的属性是什么,有利于快速理清代码脉络。面向对象代码元素的命名形式分为两大类,即字母大写的UpperCamelCase和字母小写的lowerCamelCase,前者俗称大驼峰,后者俗称小驼峰。类名采用大驼峰形式,一般为名词。方法名采用小驼峰形式,一般为动词,与参数组成动宾结构。变量包括参数、成员变量、局部变量等,也采用小驼峰形式。常量的命名方式比较特殊,字母全部大写,单词之间用下画线连接。常量和变量是基本的代码元素,就像血液中的红细胞一样无处不在。合理的命名有利于保障代码机体的清爽、健康。
在命名时若能体现出元素的特征,则有助于快速识别命名对象的作用,有助于快速理解程序逻辑。我们推荐在Java命名时,以下列方式体现元素特征:
包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,则可以使用复数形式。
抽象类命名使用Abstract或Base开头,异常类命名使用Exception结尾;测试类命名以它要测试的类名开始,以Test结尾。
类型与中括号紧挨相连来定义数组。
枚举类名带上Enum后缀,枚举成员名称需要全大写,单词间用下画线隔开。
命名好望文知义
望文知义是在不需要额外解释的情况下,仅从名称上就能够理解某个词旬的确切含义。在代码元素命名时做到望文知义,从而减少注释内容,达到自解释的目的。在实践中,望文知义的难度是大的,就好像给孩子起名一样需要反复斟酌。文不对题的命名方式,肯定会加大理解成本,更大的罪过是把程序员引导到一个错误的理解方向上。某些不规范的缩写会导致理解成本增加。比如condition缩写成condi类似随意的缩写会严重降低代码的可理解性。再比如,以单个字母命名的变量,在上下文理解时会带来很大的困扰。本书中的所有示例代码都比较精筒,没有具体业务含义。重点在于阐述示例背后的编程思维,所以采用单字母的简洁命名方式,在实际业务代码中请勿模仿。
主流的编程语言基本上以英语为基础,此处望文知义的“文”指的是英文。随着开源社区的发展与繁荣,各国程序员踊跃参与开源项目的共建,国际交流与合作越来越频繁,英语能力已经成为程序员必备的基础技能之一。虽然有人认为命名方式应该符合本国语言习惯,拼音这种命名方式,应该是被允许的,但是在国际化项目或开源项目中,对于非汉语国家的开发工程师而言,拼音这种命名方式的可读性几乎为零。
命名要符合语言特性、体现元素特征。命名做到望文知义、自解释是每个开发工程师的基本素质之一。我们在思量更好的代码元素命名的同时,也要敢于修改已有的、不合理的命名方式。
在所有代码元素中,常量和变量为常见,优雅地定义与使用好它们,是开发工程师的基本功之一。
【免责声明】:本内容转载于网络,转载目的在于传递信息。文章内容为作者个人意见,本平台对文中陈述、观点保持中立,不对所包含内容的准确性、可靠性与完整性提供形式地保证。请读者仅作参考。更多内容请加danei0707学习了解。欢迎关注“达内在线”参与分销,赚更多好礼。