使用 LDoc 文档化函数表
2016-9-8 0:35:54
收藏:0
阅读:119
评论:1
ldoc 可以很快的文档化一个函数,比如
--- Foo function
-- does a foo
function foo(param1, param2)
end
然而,我想文档化一个函数指针表格。比如
--- bar.lua ---
bar = {
foo = function(a, b, c)
end
}
return bar
--- foo.lua ---
local bar = require "bar"
fooapi {
foo = bar.foo
}
我希望用 fooapi 这个导出的 API 来文档化,来隐藏具体实现的文件名和函数名。我需要它出现在 fooapi 相关的文档中,不希望在输出中看到 bar.lua 或者 bar.foo 这些名字。
如果我在 foo = bar.foo 行下面添加一些注释并在 fooapi table 前面添加注释,那么生成的文档中会将它看作是一个普通的 table 字段而不是一个函数。
有没有办法覆盖这种行为,让 Ldoc 生成带有参数 a, b, c 的 function fooapi.foo 这样的输出?
我希望能够定义一些未展示的参数并将其类型覆盖为一个带有嵌套的函数名的函数,而不是普通的 table 字段。需要注意的是,函数嵌套可能会深入几层,在导出的 API 中。
如果需要的话,我可以重构代码。或者甚至切换到一个更不同或更灵活的工具。实际上,我并不介意它是否只是从代码中提取出一些特殊的注释,而不是生成完全由这些注释组成的文档。
点赞
评论区的留言会收到邮件通知哦~
推荐文章
- Lua 虚拟机加密load(string.dump(function)) 后执行失败问题如何解决
- 我想创建一个 Nginx 规则,禁止访问
- 如何将两个不同的lua文件合成一个 东西有点长 大佬请耐心看完 我是小白研究几天了都没搞定
- 如何在roblox studio中1:1导入真实世界的地形?
- 求解,lua_resume的第二次调用继续执行协程问题。
- 【上海普陀区】内向猫网络招募【Skynet游戏框架Lua后端程序员】
- SF爱好求教:如何用lua实现游戏内调用数据库函数实现账号密码注册?
- Lua实现网站后台开发
- LUA错误显式返回,社区常见的规约是怎么样的
- lua5.3下载库失败
- 请问如何实现文本框内容和某个网页搜索框内容连接,并把网页输出来的结果反馈到另外一个文本框上
- lua lanes多线程使用
- 一个kv数据库
- openresty 有没有比较轻量的 docker 镜像
- 想问一下,有大佬用过luacurl吗
- 在Lua执行过程中使用Load函数出现问题
- 为什么 neovim 里没有显示一些特殊字符?
- Lua比较两个表的值(不考虑键的顺序)
- 有个lua简单的项目,外包,有意者加微信 liuheng600456详谈,最好在成都
- 如何在 Visual Studio 2022 中运行 Lua 代码?

这个函数是用来 Foos 的。
它执行的是 fooapi 中的 foo 任务。
@param boolean a AAAAAAAAAAAAAAAAAAAAAAAAA.
@param number b bBbBbB。
@param string c Lorem ipsum sit dolor amet。
@function fooapi.foo
使用明确的标签,一切就都好了!