如何使用Metalua自动构建文档?
2018-3-1 14:21:7
收藏:0
阅读:121
评论:2
如何使用metalua自动构建代码文档(像doxygen一样)?
我想象中的语法如下:
--> @ARG: a(number) first Number
--> @ARG: b(number) second Number
--> @RET: bool if a was greater than b
--> @RET: number sum of a and b
--> Add a and b while comparing their values
function addcmp(a,b)
return (a>b),(a+b)
end
创建例如HTML:
<h1>addcmp</h1>
<i>Add a and b while comparing their values</i>
<h2>Arguments:</h2>
<ul>
<li><i>number</i> <b>a</b>: first Number</li>
<li><i>number</i> <b>b</b>: second Number</li>
</ul>
<h2>Returns:</h2>
<ul>
<li><i>bool</i>: if a was greater than b</li>
<li><i>number</i>: sum of a and b</li>
</ul>
当如下调用时:
metalua -v sample.mlua -o sample.html --make-doc
点赞
用户3198721
你可以进行操作。[LuaDocumentor](http://wiki.eclipse.org/Koneki/LDT/User_Area/LuaDocumentor)理解一种由[LuaDoc](https://wiki.eclipse.org/Koneki/LDT/User_Area/Documentation_Language) 评论语言大部分启发的语言,这使得Eclipse根据键入的提示自动完成您的代码,并允许生成HTML文档。
它恰好是用Metalua编写的。所有这些(Metalua和LuaDocumentor)应很快作为LuaRocks可用。
2014-01-15 15:11:11
评论区的留言会收到邮件通知哦~
推荐文章
- 如何将两个不同的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 代码?
- addEventListener 返回 nil Lua
- Lua中获取用户配置主目录的跨平台方法
你也可以尝试使用 luadoc。默认的文档生成模板非常好,并且你也可以对一个目录下的所有文件运行它。
Kepler 项目文档 是一个很好的展示结果的方法。