如何使用Metalua自动构建文档?

如何使用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
点赞
用户1190388
用户1190388

你也可以尝试使用 luadoc。默认的文档生成模板非常好,并且你也可以对一个目录下的所有文件运行它。

Kepler 项目文档 是一个很好的展示结果的方法。

2013-08-13 09:19:00
用户3198721
用户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