Exp Lua

lua-users home
wiki

ExpLua 既是一种代码注释格式,也是一种用于提取这些注释并导出 HTML、LaTeX 等格式的工具。它可以免费使用,并与 Lua 项目使用相同的许可证,并附带通常的免责声明。

最新的 explua 压缩包可以在 Wiki 上找到:Files:wiki_insecure/users/miller/explua.tar.gz 请注意,这是一个公共网站,因此代码本质上是不可信的。首先,包中**只能**包含 lua 文件。

LaTeX(后来使用我自己的宏等转换为 PS)内容的示例可以在 Files:wiki_insecure/users/miller/concur.ps.gz 找到。


这是一个仍处于胚胎阶段的项目。我主要是在这里上传,以回应 Reuben 的电子邮件。在下一节中,我附上了对他的邮件的回复。请随时添加评论、问题或意见,如您所见。输出生成目前使用大量的小型连接,这很慢,我知道这一点。它将被改变。--Pedro

On Sunday 19 October 2003 20:32, Reuben Thomas wrote:
> I intend to fix on a system to use soonish (to make the libraries more
> easily usable), so it would be nice to know how ExpLua works even if it's
> not ready yet.
好的。我一直在以一种自适应、渐进、迭代细化的方式处理整个系统——也就是说,有时会花 20 分钟进行拼凑,有时会整晚设计/构建/测试一大堆东西——主要针对我的论文自动记录函数和模块(它有很多函数和模块,我不想写两次并维护两个版本)。

我一开始尝试使用其他可用的系统(例如 LuaDoc?、JavaDoc?,甚至文学编程),但发现它们往往会妨碍我的糟糕编程习惯。不幸的是,它们对我来说不够强大和令人满意,无法让我放弃我的弱点并开始正确设计——我只会厌倦输入 @param 标签,并完全停止注释。

因此,我想我想要一个注释系统,它在编程时更易于输入,即使你不理解特定的注释格式也易于阅读。我选择了一个这样的符号系统

对于整个文件

--| Begins a module/file comment, e.g., "this file does *this*".
--by Pedro Miller Rabinovitch <[email protected]>
--$Id: myfile.lua,v 1.12 2003/10/17 00:13:56 miller Exp $
--TODO lots of stuff.
(--by 和 --TODO 都可以缩写为 --b 和 --T)

在每个函数之前

--% This is the purpose of the function, i.e., what it *does*.
--- And this is the second line, which will concatenated to
--- the others.
--@ first (string) Text of the first parameter
--@ what (table) The second parameter is the table used for an
--- example
--@ [...] (any) Optional parameters to the called whatever
--: (number) Number of whatevers done or nil if an error occured
function Module:MyFunction( first, what, ... )
(我还没有决定一个“替代”格式,例如 (number|nil)、(number, nil)。当前实现不允许多个返回值,但这将尽快改变。)

目前就这些了。我正在计划一些更进一步的东西(比如 --& 和 --. 分别用于重要的表格和字段,我还需要某种类型定义),但重要的东西都在这里了。

最棒的是,现在它变得如此简单,我正在记录更多代码。我拥有的文档越多,我就越想提取它并生成东西……

够了。我还有更多要讨论的,但现在没时间了。


最近更改 · 偏好设置
编辑 · 历史记录
最后编辑于 2003 年 10 月 20 日下午 2:41 GMT (差异)