lua - 如何使用 metalua 自动构建文档？

Question

如何使用 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

Answer 1

您也可以尝试luadoc。默认的文档生成模板非常简洁，您也可以为目录中的所有文件运行它。

Kepler 项目文档是查看结果的好方法。

Answer 2

是的你可以。LuaDocumentor理解一种很大程度上受 LuaDoc 启发的注释语言，它允许 Eclipse 根据输入提示自动完成您的代码，并允许生成 html 文档。

它恰好是用 Metalua 编写的。所有这些（Metalua 和 LuaDocumentor）应该很快就会作为 LuaRocks 提供。