Lua 中的自文档参数

我正在寻找一种方式来澄清我的 Lua 函数的契约。特别是，哪些属性是参数应该具备的。

为了说明我的问题，这里是一些代码片段，展示我的当前代码的典型结构。一个用两个公共函数构建一个新的"实例"的函数。

local function newTextPrinter(color)
    return {
        print = function(textToPrint)
            PrintText(textToPrint, 20, color, 5, 'center');
        end,
        printBig = function(textToPrint)
            PrintText(textToPrint, 30, color, 5, 'center');
        end
    }
end

一个接受一个参数的函数，该参数应具有相同的签名（或超集）。

local function printSomeStuff(textPrinter)
    textPrinter.print("some")
    textPrinter.printBig("stuff")
end

调用后面的函数

local textPrinter = newTextPrinter("ffffffff")
printSomeStuff(textPrinter)

这段代码的问题在于，你无法知道提供给printSomeStuff的textPrinter参数应该长成什么样，而不用查看printSomeStuff的实现。虽然通过这个例子很容易做到这一点，但通常情况下并非如此（而且在我的情况下，这样做还需要在文件之间跳转）。还没有提示可以通过newTextPrinter获得一个合适的值，除了名称上的相似之外。

有没有一种方法可以使代码更加自说明，更好地展示作者的意图？

我更喜欢一种轻量级的方法，不会尝试模拟基于类的继承。同样，代码优于文档，如果不行，我更喜欢以工具理解的格式编写文档，而不是自由格式的文档。显然，我只需要写一个注释，比如"参数textPrinter需要具有print和printBig公共函数"，但是如果没有任何东西告诉您关于文档中的错误或者在重构代码时忘记更新文档，那么这将非常容易出错。

我使用的是 Lua 5.0，对这种语言还很新。