欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

Lua:编码约定

程序员文章站 2022-04-27 18:44:07
...

Lua:编码约定

作为个人日常Lua编码约定,无意成为规范

1. 文件夹

全小写不添加任何分隔

# 自动战斗
systemcore

2. 文件

全小写多个单词以下划线分隔

tools.lua
auto_login.lua

3. 变量

3.1. 命名

驼峰命名,首字母小写后面每个单词首字母大写

local myName = "yimt"

3.2. 全局变量

禁止使用全局变量,所以方法使用外部变量显示传递

4. 常量

全大写多个单词以下划线分隔

Lua常量都是模拟,一般我使用话常量也用变量代替

local LIMIT_COUNT = 4

5. 变量和常量附加

5.1. 变量或常量为function类型

当变量或常量为function类型,变量或常量名以func开头

例:

local funcCallback = function()
end

6. 模块

6.1. 模块内命名

模块名:首字母小写后面每个首字母大写
模块方法名:首字母小写后面每个首字母大写

例:

login = {}

function login.loginGame()
end

return login

6.2. 模块引用

禁止一次性将所有需要引入,不论哪个方法,只允许引入自己使用的模块,禁止提前引入

错误示例

function main()
    -- 错误示例
    -- const和config模块未使用但引入
    local const = require("const")
    local config = require("config")
    local login = require("login")

    state = login.loginGame()
    if state == -1 then
        return -1
    end

    return 0
end