如何使用 LuaDoc 记录闭包？

2014-3-7 18:59:44
收藏：0
阅读：89
评论：1

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

--- Agent constructor
-- @return 描述 Agent 行为的函数
Agent = function(data)
   return function(arg1, arg2, ...) end
end

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

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

在 LuaDoc 中有没有标准的文档方式来记录以上构建方式？

点赞
用户646619
用户646619

你可以通过手动指定文档名称和类型来完成：

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

参见 http://keplerproject.github.io/luadoc/manual.html#tags。

2014-03-08 19:09:29

作者:

用户2099889

用户2099889
推荐文章