Lua代码编写规范.docxVIP

-- --@return 若可以到达，返回 true ；否则返回 false Lua 代码编写规范 Lua 代码编写规范 开发中，大量使用 lua ，暂时根据当前状况，总结相对而言 较好的规范，在多人协作中可以更好的开发、交流。 介绍 该文档旨在为使用 lua 编写应用程序建立编码指南。 制订编码规范的目的： 统一编码标准，通用，提高开发效率；使代码通俗易懂， 统一编码标准，通用，提高开发效率； 使代码通俗易懂， 易于维护。 切记：善用调试器。 1．所有 lua 文件命名时使用小写字母、下划线 2．类名、变量名尽可能使用有意义的英文，类名使用帕斯 命名法，变量名使用骆驼式命名法 3．常量、消息号定义时用大写，单词间 3．常量、消息号定义时用大写，单词间 分割 eg:KIND_PET_FOOD 4．枚举值定义时 加前缀 enum 5. 函数名使用骆驼式命名法 注： 骆驼式命名法：第一个单字以小写字母开始；第二个单字的 首字母大写或每一个单字的首字母都采用大写字母 帕斯卡命名法：和骆驼命名法很像，只有一点区别，就是首 字母要大写。 (单字之间不以空格断开或连接号 ) 文件组织 文件开头加上此文件的功能、职责的简要描述； 如下： -- Author: Feng -- Date: XXXX-XX-XX -- 功能描述 每个文件都加 module 限定词； 导入的模块都加 local 限 ，这样便于进B 点( newx,定词；或者使用 (module( ，这样便于进 B 点( newx, 行热更新 所有提供外部函数都加如下格式的注释。 例如： --此函数检测是否可以从 A(oldx, oldy) 点走到 newy ) --@param oldx当前所在点--@param oldy当前所在点--@param newx目标点 --@param oldx 当前所在点 --@param oldy 当前所在点 --@param newx 目标点 x --@param newy 目标点 y function Object:checkBar(oldx, oldy, newx, newy) end 3.函数与函数间、以及一些定义之间加上空行。 3. 函数与函数间、以及一些定义之间加上空行。 4.函数内的临时变量、文件内的局部函数都加上 local 限定 4. 5.函数的行数过长（大于 100 行）时，尽量拆分为多个子 5. 些晦涩的部分，一定要加上注释。 6. 短小的注释使用 6. 短小的注释使用 较长的注释使用 --[[ ]] 7. assert 函数开销不小，请慎用。 8. Lua 8. Lua 类设计时，用元表来实现 oop。 不要直接增加函数成员，因为直接增加函数成员会导致内存 增加并且在 jit 下执行效率和用元表方式无差异。 9. 文件使用 UTF8 格式 分隔和缩进 1. 使用空行 在下述情况下使用单行的空白行来分隔： 1）在方法之间 2）在方法内部代码的逻辑段落小节之间 3）在注释行之前 注释之前增加一行或者多行空行。 2.使用空格符 80 80 除正常的成分之间以空格符分隔名（如数据类型和变量名之 间），在下述情况下也应使用一个空格符来分隔： 1）运算符和运算符之间，如： 2）在参数列表中的逗号后面，如： function m1(year, month) end 3） 在 for 语句时，如： for k, v in pairs(t) do end 4）在下列情况下不要使用空格。 例如： 函数定义时： function test1(a) end 不要这样： function test1( a ) end 函数调用时： test1(3) 不要这样： test1( 3 ) 不要如此的原因在于： a）.容易忘记相关空格，导致风格不统一，这样还不如不加; b）.lua 解析语法时是采用空格等分割来解析的， 某些情况下， 若不小心加空格会导致非预期的结果。 使用换行符 不建议在一行中写多条语句， 一条语句的长度一般超过了 个字符时，应该换行 使用小括号 可以使用小括号来强行规定运算顺序 5. 使用缩进 在下述情况下应用缩进 1）类中的成分 2）方法体或语句块中的成分 3）换行时的非起始行 缩减量一般为在上一级成分的基础上跑到下一个制表位 四、代码建议： 1．代码中使用的一些函数尽可能在文件开头或者当前局部 环境中加 local 前缀重新定义下。 例如： local assert = assert 2. 尽量减少表中的成员是另一个表的引用。 2. 尽量减少表中的成员是另一个表的引用。 考虑 lua 的垃圾 收集机制、内存泄露等。 3．高级特性尽可能不用 4．写代码时尽可能写的简单，考虑性能时先做好推断，看 看能提升多少，增加的复杂度以