做这个决定是因为看看以前的代码风格差异太大了,一会东一会西,现在决定使用一套固定的命名规则,可以清楚的分别文件模块、变量、常量、函数、类
命名规则采用Camel-Case法则与下划线规则相结合,因为下划线会比Camel-Case多占许多位子,而且在某些情况下仅使用大小写更容易被机器识别
举例
Camel-Case | 下划线 |
---|---|
myName | my_name |
onTimer | on_timer |
isOnlinePlayer | is_online_player |
willReturnToHall | will_return_to_hall |
接下来约定一下常见的几大类命名规则
种类 | 规则 | 示例 |
---|---|---|
类名 | 首字大写 | Player |
文件夹名 | 全部小写,以下划线相连接 | my_desk_top |
文件名 | 首字小写,以下划线相连接 | global_Manager.lua |
变量名 | 首字小写,以名词开头,不使用下划线连接 | playerIsOnline |
函数名 | 首字小写,以动词开头,不使用下划线连接 | onHandler |
常量 | 首字小写,以k开头,不使用下划线连接 | kMaxPlayerCount |
以上为总体规则,以后常看此规则,以简化阅读代码的时间