命名法,命名 · Lua代码风格指南 · 看云

命名法,命名 · Lua代码风格指南 · 看云

命名

最好的代码是自文档化代码，它不需要额外的注释，并且有描述作者意图的信息。良好的命名风格是自记录代码的基础。

命名法 CamelCase 下划线

无论你使用驼峰式还是下划线，重要的是你使用你喜欢的命名法并坚持下去。

变量名长度

范围较宽的变量名通常比范围较小的变量名具有更多的描述性信息。例如：i经常在循环中用作计数变量，将其用作全局变量很容易导致很多问题。

变量命名

对于变量（包括函数）命名法,命名 · Lua代码风格指南 · 看云，小驼峰式或小下划线是一个不错的选择。例如：curSpeed表示当前速度，canDrop表示是否可以掉落等

对于布尔变量，通常以is为前缀很容易理解。例如，isRemoved 比 Removed 更好地表明这是一个布尔变量。

Lua中有一个特殊的变量名：_命名法，常用于表示可以忽略不使用的变量，常用于循环中。

-- `_`表示表的键可以被忽略，只在循环内使用表中的值`v`
for  _,v  in  ipairs(t)  do  print(v)  end

在表格和函数参数列表的循环中，i总是代表ipairs下的数组下标，k总是代表pairs下的key，v总是代表对应的值，t代表表格。

for  k,v  in  pairs(t)  do  ...  end
for  i,v  in  ipairs(t)  do  ...  end
mt.__newindex  =  function(t,  k,  v)  ...  end

固定命名

Lua中没有严格的常量定义标识符，所以常量的命名尤为重要。

常量通常使用大下划线命名法。每个字母都大写以便突出，每个单词都带有下划线以便于阅读。

例如：MAX_SPEED表示最大速度，IS_SHOW_DEBUG_ERROR_MSG表示是否显示错误信息等。

类名

为了不与变量名和常量名混淆，类名通常使用驼峰式命名法,命名 · Lua代码风格指南 · 看云，即首字母大写。例如：TouchManager 表示触摸管理器类。

包和模块名称

包和模块名称通常很短且全部小写，单词之间没有下划线。比如文件读取库名是lfs命名法，意思是Lua File System； XML解析库名称是lxp，意思是Lua XML Parser等等。

文件名

通常为避免与类名混淆，文件名通常使用小驼峰式大小写或小下划线表示法。