abaojin 开发工程师

lua 编码规范

2020-04-25
lua

目的

  • 统一编码标准,提高开发效率。
  • 便于代码阅读,降低维护成本。

编码规范

命名惯例

  • 所有lua文件命名时使用小写字母、下划线。
  • 类名、变量名尽可能使用有意义的英文,类名使用帕斯卡命名法,变量名使用骆驼式命名法。
  • 常量、消息号定义时用大写,单词间 _ 分割 eg:KIND_PET_FOOD。
  • 函数名使用骆驼式命名法。

解释:

  • 骆驼式命名法:第一个单字以小写字母开始;第二个单字的首字母大写或每一个单字的首字母都采用大写字母。
  • 帕斯卡命名法:和骆驼命名法很像,只有一点区别,就是首字母要大写。(单字之间不以空格断开或连接号)。

分割规范

  • 使用空行
    • 在方法之间。
    • 在方法内部代码的逻辑段落小节之间。
    • 在注释行之前。
  • 使用空格符
    • 运算符和运算符之间,如: c = a + b。
    • 在参数列表中的逗号后面,如: function m1(year, month)。
    • 在for语句时,如:for k, v in pairs(t) do。
  • 不使用空格符
    • 函数定义,如:function test1( a )。
    • 函数调用,如:test1( 1 )。
  • 使用换行符
    • 禁止在一行中写多条语句。
    • 一条语句的长度一般超过了80个字符时,应该换行。

代码建议

  • 通用逻辑不建议依赖逻辑数据层

参考资料

lua源码


Similar Posts

上一篇 lua 性能分析

评论