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。默认的doc生成模板非常简洁，您也可以为目录中的所有文件运行它。

Kepler Project documentation是查看结果的好方法。

Answer 2

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

碰巧是用Metalua写的。所有这些（Metalua和LuaDocumentor）很快就会以LuaRocks的形式出现。

如何使用metalua自动文件？

2 个答案: