一. 源文件
- 文件采用UTF-8编码
- 文件后缀为小写的"lua"
二. 命名
- 类(class)文件名使用大驼峰式
- 普通文件名,变量名,函数名使用小驼峰式
- 变量名尽量绕开系统保留字
- 全局变量使用全大写,以"_"分割单词
- 命名尽量用有意义的英文
- 如果单词过长,可使用缩写
- 英文单词过于复杂时,才能使用拼音
三. 排版
- 使用't'(tab)进行代码缩进
- 比较符(=,==,>,>=,<,<=),连接符(..),运算符(+,-,*,/,%,^)左右需要有空格
- 逗号前不需要空格,逗号后需要有空格
- 括号不需要空格
- 函数之间用空行隔开
- 代码块含义不同时,用空行隔开
- 不允许一次使用多个空行
- if,for,while等语句独立成行
- 一次只声明一个变量
四. 注释
- 单行注释用"–"
- 多行注释用"–[[ –]]"
-
注释区域
版本,版权说明
类说明,文件说明
函数接口说明
变量,全局变量
重要代码块 - 注释上方需要空行,下方不需要
五. 其他
-
判空初始化
1local data = data or {} -
三元运算
1local d = a and b or c