lua代码规范

Lua代码风格

目录

• 一、程序的版式
  
  • 1.1 空行
  • 1.2 空格
  • 1.3 长行拆分
  • 1.4 使用缩进
• 二、命名规则
  
  • 2.1 共性规则
  • 2.2 文件命名
  • 2.3 类的命名
  • 2.4 变量命名
  • 2.5 常量，事件名的命名
  • 2.5 枚举
• 三、文件组织
  
  • 3.1 文件描述
  • 3.2 文件中变量的定义
  • 3.3 类变量的定义
  • 3.4 函数参数的定义
  • 3.5 函数的定义规则
  • 3.6 注释的使用
• 三、分隔和缩进
  
  • 3.1 使用空行
  • 3.2 使用空格符
  • 3.3 使用换行符
  • 3.4 使用小括号
  • 3.5 使用缩进
• 四、编程技巧
  
  • 4.1 应该尽量使用local变量而非global变量
  • 4.2 临时变量的处理
  • 4.3 利用逻辑运算的短路效应
• 五、代码建议
  
  • 5.1 代码的调试
  • 5.2 复杂度和性能问题
  • 5.3 函数的优化思考
  • 5.4 提交代码的检查
  • 5.5 表结构的引用

一、程序的版式

Code is read much more often than it is written.

Programming style is an art.

1.1 空行

• 需加空行：
  
  • 函数之间都要加空行；
  • 函数内部代码概念与逻辑之间，逻辑段落小节之间，都应该加空行；
  • 注释行之前。
• 不加空行：
  
  • 在一个函数体内，逻揖上密切相关的语句之间不加空行；
  • 多行注释解释参数的时候，注释之间不加空行。

1.2 空格

• 需加空格：

  • ”and“，”or“等关键字前后留一个空格，便于辨析；
  • 逗号”,“后面要留一个空格；
  • 赋值操作符、比较操作符、算术操作符如”=“、 “==“、”~=“、”>=“、”<=