浅谈两种常见的lua表代码结构写法的优缺点

第1种写法（实际案例：Yutils.lua）

local test

test = {
        math = {
                distance = function(x, y, z)
                        if type(x) ~= "number" or type(y) ~= "number" or z ~= nil and type(z) ~= "number" then
                                error("one vector (2 or 3 numbers) expected", 2)
                        end
                        return z and math.sqrt(x*x + y*y + z*z) or math.sqrt(x*x + y*y)
                end
        },
}

return test

优点：开发者进行长期开发维护时，以上述写法编写出来的lua代码在各种IDE中（VSCode、Sublime、Notepad++等）进行折叠代码操作时，熟悉快捷键的人可以迅速折叠当前不需要分析的代码，仅展开当前需要的部分进行分析，分析完之后在界面中上下翻动时，所需要的时间也更短。

如下图给出了在VSCode中折叠的例子：

缺点：不知道折叠代码这个操作的人很难理解为什么要像上面这样写，代码长了的情况下就不好确定当前的代码内容隶属于哪个上级表了。鄙人也是因为这点，给各个子表打了几百行各部分代码对应的上级表的注释。（然而知道折叠之后才发现这么做其实没必要）

第2种写法（实际案例：Effector-utils-lib-3.5.lua）

local test = {math = {}}

function test.math.distance(x, y, z)
        if type(x) ~= "number" or type(y) ~= "number" or z ~= nil and type(z) ~= "number" then
                error("one vector (2 or 3 numbers) expected", 2)
        end
        return z and math.sqrt(x*x + y*y + z*z) or math.sqrt(x*x + y*y)
end

return test

优点：对初学者而言，可以尽可能控制表代码深度，有助于快速上手。

缺点：如果进行长期开发，写出那种上万行的脚本以后，在脚本内要进行上下文本代码分析，特别是折叠代码的时候，就比较折磨了。这种写法做不到像第1种写法那样高效折叠成千上万行代码。