lua代码编写规范介绍.pdfVIP

代码编写规范 开发中，大量使用lua，暂时根据当前状况，总结相对而言较好的规范，在多人协作中可以 更好的开发、交流。 介绍 该文档旨在为使用lua编写应用程序建立编码指南。 制订编码规范的目的：  统一编码标准，通用。提高开发效率；  使代码通俗易懂，易于维护。 切记：善用调试器。 目录 代码编写规范1 目录1 一、 命名惯例3 1．所有lua 文件命名时使用小写字母3 2 ．类名、变量名等全小写，尽可能使用有意义的英文，单词若生僻，则用 _ 分割3 3 ．文件内局部变量加 s_前缀3 4 ．常量、消息号定义时用大写，单词间 _ 分割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 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． 写代码时尽可能写的简单，考虑性能时先做好推断，看看能提升多少，增加的复 杂度以及造成的代码晦涩有多严重，然后再决定如何做10 5． 加载的xml 数据表，尽可能的做好数据校验，若校验失败，要出发断言，使服务 器无法启动；不要等出错时，回过头来检查是数据表问题还是逻辑问题。10 6． 出错时，记录好错误日志。10 7． 提交代码之前，去掉或者注释掉无关的代码；测试下保证服务器可以正确启动。 10 8． 尽量减少表中的成员是另一个表的引用。 考虑 lua 的垃圾收集机制、内存泄露 等。 10 一、 命名惯例 1．所有lua 文件命名时使用小写字母 2．类名、变量名等全小写，尽可能使用有意义的英文，单词若生僻，则用 _ 分割 3．文件内局部变量加 s_前缀 4．常量、消息号定义时用大写，单词间 _ 分割 5．枚举值定义时 加前缀 enum_ 二、 文件组织 1. 文件开头加上此文件的功能、职责的简要描述；每个文件都加module 限定词；导 入的模块都加 local 限定词； 2. 所有函数都加如下格式的注释。 例如： --此函数检测是否可以从A(oldx, oldy)点走到B 点（newx, newy） --@param oldx 当前所在点x --@param oldy 当前所在点y --@param newx 目标点x --@pa