Lua语言规范 - kyohwang/games GitHub Wiki

Lua 语言规范

强制规范

1.文件命名使用帕斯卡命名例:BaseView  保证文件名全项目唯一
2.全局变量G_XXXX 模式
3.事件同常量分层制定
4.枚举值同常量分层制定
5.注释  10 行以上的或两个参数以上或圈复杂度大于2  的代码必须写注释
6.变量访问外部访问变量值时,避免直接使用变量改为get set以变量名加get set 前缀并将变量名首字母大写
7.Svn 提交需要分功能进行,不能一次性提交多个功能
8.如果文件是一个类的话确保类名和文件名相同
9.成员变量申明必须在ctor 方法中进行申明
10.统一日志接口
11.提交代码时尽量将无意义的打印取消
12.变量命名规则使用小驼峰法命名	
13.函数申明 函数名使用小骆驼命名法

建议规范

1. 如果一个函数行数过长那么就需要考虑是否能够拆分为多个函数
2.方法返回不建议返回多个值
3.避免使用local item1,item2 = 1,2这种方法能够分开写的尽量分开
4. global变量使用被多次读取的global变量,应提取出来放到local变量中