如何使用 LuaDoc 记录闭包？

【问题标题】：How to document a closure with LuaDoc?如何使用 LuaDoc 记录闭包？
【发布时间】：2014-03-07 18:52:28
【问题描述】：

假设我有一个返回闭包的函数：

--- Agent constructor
-- @return A function describing the behavior of the agent
Agent = function(data)
   return function(arg1, arg2, ...) end
end

然后我有一个接收该闭包的变量：

SugarAgent = Agent{ metabolism=5, health=3 }

LuaDoc 中是否有标准方法来记录上述构造？

【问题讨论】：

标签： lua luadoc

【解决方案1】：

您可以通过指定文档名称并手动输入来做到这一点：

--- This is a SugarAgent
-- @name SugarAgent
-- @class function
-- @return Some value
SugarAgent = Agent{ metabolism=5, health=3 }

【讨论】：

我实际上是在尝试记录 AgentSugar 函数，但您的答案非常接近我的要求。
抱歉，实际上是@class，而不是@type（请参阅keplerproject.github.io/luadoc/manual.html#tags）。有人试图用正确的信息编辑帖子，但编辑被拒绝，因为它“不正确”。叹息。