给代码起个好名字,有助于理顺代码逻辑,提高代码的清晰度,提高开发效率。
目前,比较常用的命名方法有:
- 驼峰命名法
- 蛇形命名法
- 串式命名法
- 匈牙利命名法
本文主要介绍驼峰命名法。
1.驼峰命名法
驼峰命名法分为“大驼峰命名法”和“小驼峰命名法”,它们用于表示不同的类型。
“大驼峰命名法”是每个单词首字母大写,其它字母小写,然后将所有的单词连在一起,如:HttpRequest。
“小驼峰命名法”是第一个单词首字母小写,其它同“大驼峰命名法”,如:centerPoint。
2.常用命名规范
类型 | 命名方法 | 示例 |
---|---|---|
类 | 大驼峰命名法 | StudentManager |
方法 | 大驼峰命名法 | GetCenterPoint |
变量 | 小驼峰命名法 | centerPoint |
常量 | 蛇形命名法,大写字母 | MAX_VALUE |
3.怎样取一个好名字
3.1 有准确的意义
名字要准确、完整的表达出它代表的意义。 如:
int clientId;
就比
int c;
更能体现它代表的意义。
3.2 遵守命名规范
不同的编程环境,偏爱不同的命名规范。 如:
- Java 偏爱使用驼峰命名法;
- C 语言偏爱使用蛇形命名法;
- CSS 使用串式命名法;
如果团队定义了自己的命名规范,要严格遵守。否则要遵守业界公认的命名规范。
3.3 可读性优先
可以通过以下几点提高名称的可读性:
- 使用完整的词汇,避免缩写、简写,除非这些缩写被广泛认可(如PI)。
- 避免使用单个字母。
- 避免使用汉语拼音。