《lua代码编写规范》由会员分享，可在线阅读，更多相关《lua代码编写规范（10页珍藏版）》请在金锄头文库上搜索。
1、代码编写规范代码编写规范 开发中，大量使用 lua，暂时根据当前状况，总结相对而言较好的规范，在多人协作中可以 更好的开发、交流。 介绍介绍 该文档旨在为使用lua编写应用程序建立编码指南。 制订编码规范的目的： 统一编码标准，通用。提高开发效率； 使代码通俗易懂，易于维护。 切记：善用调试器。切记：善用调试器。 目录目录 代码编写规范 . 1 目录. 1 一、一、 命名惯例命名惯例 . 3 1所有 lua 文件命名时使用小写字母 . 3 2类名、变量名等全小写，尽可能使用有意义的英文，单词若生僻，则用 _ 分割. 3 3文件内局部变量加 s_前缀 . 3 4常量、消息号定义时用大写，单词间
2、_ 分割 . 3 5枚举值定义时 加前缀 enum_ . 3 二、二、 文件组织文件组织 . 3 1. 文件开头加上此文件的功能、 职责的简要描述； 每个文件都加 module 限定词； 导入的模块都加 local 限定词； . 3 2. 所有函数都加如下格式的注释。 . 3 3. 函数与函数间、以及一些定义之间加上空行。 . 3 4. 文件内不允许出现全局变量，_G.instance 例外 . 3 5. 函数内的临时变量、文件内的局部函数都加上 local 限定词 . 3 6. 常量、消息号、枚举值行末都加上分号。 . 3 7. 函数的行数过长（大于 100 行）时，尽量拆分为多个子函数；函
3、数中一些晦涩的部 分，一定要加上注释。 . 3 8. 短小的注释使用 -； 较长的注释使用 - . 3 9. assert 函数开销不小，请慎用。 . 3 10. Lua 类设计时，用元表来实现 oop。 . 3 三、三、 分隔和缩进分隔和缩进 . 8 1. 使用空行 . 8 2. 使用空格符 . 8 3. 使用换行符 . 9 4. 使用小括号 . 9 5. 使用缩进 . 9 四、四、 代码建议：代码建议： .10 1 代码中使用的一些函数尽可能在文件开头或者当前局部环境中加 local 前缀重 新定义下。 .10 2 不要使用元表来实现继承 .10 3 高级特性尽可能不用.10 4 写代码时
4、尽可能写的简单，考虑性能时先做好推断，看看能提升多少，增加的复杂度以及造成的代码晦涩有多严重，然后再决定如何做.10 5 加载的 xml 数据表，尽可能的做好数据校验，若校验失败，要出发断言，使服务 器无法启动；不要等出错时，回过头来检查是数据表问题还是逻辑问题。 .10 6 出错时，记录好错误日志。 .10 7 提交代码之前， 去掉或者注释掉无关的代码； 测试下保证服务器可以正确启动。10 8 尽量减少表中的成员是另一个表的引用。 考虑 lua 的垃圾收集机制、内存泄露 等。 10 一、一、 命名惯例命名惯例 1所有 lua 文件命名时使用小写字母 2类名、变量名等全小写，尽可能使用有意义的
5、英文，单词若生僻，则用 _ 分割 3文件内局部变量加 s_前缀 4常量、消息号定义时用大写，单词间 _ 分割 5枚举值定义时 加前缀 enum_ 二、二、 文件组织文件组织 1. 文件开头加上此文件的功能、 职责的简要描述； 每个文件都加 module 限定词； 导入的模块都加 local 限定词； 2. 所有函数都加如下格式的注释。 例如： -此函数检测是否可以从 A(oldx, oldy)点走到 B 点（newx, newy） -param oldx 当前所在点 x -param oldy 当前所在点 y -param newx 目标点 x -param newy 目标点 y -retur
6、n 若可以到达，返回 true；否则返回 false function obj:checkbar(oldx, oldy, newx, newy) end 3. 函数与函数间、以及一些定义之间加上空行。 4. 文件内不允许出现全局变量，_G.instance 例外 5. 函数内的临时变量、文件内的局部函数都加上 local 限定词 6. 常量、消息号、枚举值行末都加上分号。 7. 函数的行数过长（大于 100 行）时，尽量拆分为多个子函数；函数中一些晦涩的部分，一定要加上注释。 8. 短小的注释使用 -； 较长的注释使用 - 9. assert 函数开销不小，请慎用。 10. Lua 类设计时，用元表来实现 oop。 不要直接增加函数成员，因为直接增加函数成员会导致内存增加并且在 jit 下执行效率和用元表方式无差异。 -一个典型的类定义如下： -baseobj.lua module(., package.seeall) -类方法定义 lo
