命名规范:
1. 变量和函数命名:
- 使用有意义的变量和函数名,描述性强。
- 遵循驼峰命名法,例如 myVariable、calculateScore。
2. 常量:
- 使用全大写字母,并用下划线分隔单词,例如 MAX_SCORE。
3. 表(table):
- 表使用驼峰命名法,例如 myTable。
4. 模块和文件名:
- 使用有意义的名字,描述性强。
- 文件名使用小写字母和下划线。
缩进和格式:
1. 缩进:
- 推荐使用两个空格进行缩进。
2. 代码块:
- 使用 then 和 end 标记条件和循环块。
- 在 if、while、for 等关键字后换行,保持代码清晰。
if condition then
-- code
elseif anotherCondition then
-- code
else
-- code
end
for i = 1, 5 do
-- code
end
3. 函数定义和调用:
- 函数定义时,在函数名后空一格。
- 函数调用时,函数名后不加空格。
function myFunction(parameter)
-- code
end
myFunction(argument)
注释:
1. 行注释:
- 使用 -- 进行单行注释。
-- 这是一个单行注释
2. 块注释:
- 使用 --[[ 和 ]]-- 进行多行注释。
--[[
这是一个
多行注释
]]
字符串:
1. 字符串连接:
- 使用 .. 连接字符串。
local result = "Hello, " .. "World!"
2. 长字符串:
- 使用 [[ ... ]] 表示长字符串。
local longString = [[
This is a long string
spanning multiple lines.
]]
避免全局变量:
1. 使用局部变量:
- 避免过多的全局变量,使用局部变量限制变量的作用域。
local localVar = 10
模块和require:
1. 模块封装:
- 使用模块封装相关的功能,提高代码的可维护性。
2. 使用require:
- 使用 require 导入模块。
local myModule = require("myModule")
这些规范只是一些建议,实际上,编写规范取决于项目和团队的具体情况。在团队协作中,一致性更为重要,因此建议团队在项目中采用相似的编写规范。
转载请注明出处:http://www.zyzy.cn/article/detail/6521/Lua