问题标签 [luadoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
1892 浏览

documentation - lua - 文档的元数据

我已经阅读了 Norman Ramsey 关于使用元数据在 lua 中生成文档的评论。

我正在尝试从我的库中生成文档,如果可能的话,我宁愿不使用 luadoc。

我想更多地了解这种用于生成文档的“面向元数据”的方法——方法、示例或使用的程序。

欢迎其他答案,但这是一个诺曼可能比其他任何人都能回答得更好的问题。

谢谢!

0 投票
1 回答
231 浏览

lua - 将 LuaDoc 与 .lua 以外的扩展名一起使用

我目前正在为一个需要扩展名的新应用程序开发 lua 脚本xx_lua。我的 .lua 扩展名的 luadoc 工作正常,我知道我可以简单地将文件重命名为 lua 扩展名创建文档并将它们重命名,但我个人更喜欢更优雅的解决方案。

是否可以让 luadoc 查看其他扩展。我试过打电话

但即使路径中有大量具有该扩展名的文件,也会导致没有输出。

0 投票
1 回答
350 浏览

regex - 我不明白的正则表达式

我正在关注 luadoc 中的这几行(稍作修改),这些行显然是在构建具有完整路径的文件名。但我根本不明白第 5 行发生了什么。参数filename可能类似于“myfile.lua”。

第 5 行发生了什么?

0 投票
2 回答
3630 浏览

lua - Lua 注释 --~

我知道LuaDoc在第一行这样的评论中使用“---”:

但是我在评论的开头看到了这一点:

它有什么特殊含义吗?

0 投票
0 回答
1448 浏览

vim - 如何在 Lua 代码中格式化 LuaDoc 多行注释

我有一个很长的 Lua (LuaDoc) 注释,我想使用 VIM 命令 'qgap' 将其转换为多行注释。猜想 .vimrc 中有一些带有格式注释的解决方案,但我自己无法弄清楚。

例子:

应成为:

0 投票
2 回答
681 浏览

documentation - 如何在 LuaForWindows 中使用 LuaDoc

问题都在标题中:如何将 LuaDoc 与 LuaForWindows 一起使用?

在我的 Lua 安装中,我有一个 luadoc_start.bat,但命令窗口一打开就关闭。从那里我不知道我还能做什么。

有什么帮助吗?谢谢

0 投票
1 回答
539 浏览

lua - 如何在 ubuntu/linux 中使用 luadoc?

正如标题所说,如何在 ubuntu/linux 中使用 luadoc?我使用批处理文件在 Windows 中生成了文档,但在 ubuntu 中没有成功。有任何想法吗?

0 投票
1 回答
312 浏览

lua - 如何使用 LuaDoc 记录闭包?

假设我有一个返回闭包的函数:

然后我有一个接收该闭包的变量:

LuaDoc 中是否有标准方法来记录上述构造?

0 投票
1 回答
689 浏览

lua - 为 lua 生成文档时出错

我正在尝试为我的lua项目生成文档

我有我的lua安装文件夹,里面有luafilesystemlualogging但是当我尝试使用生成文档时,luadoc-start.bat我得到一个错误,说lfs找不到模块

我认为lfs意味着luafilesystem

所以我的问题是如何安装和配置luadoc工具的依赖项?

我正在使用这个工具作为这篇文章说如何将 LuaDoc 与 LuaForWindows 一起使用

我想知道这是否正确?

我从手册中看到了安装说明,但对我来说看起来模棱两可

谢谢

0 投票
1 回答
559 浏览

lua - 使用 LDoc 为带有索引页面的整个 lua 项目生成文档

我想为我的lua项目生成文档,但Ldocdocs为每个lua文件生成,并且每次覆盖文件时输出index.html文件。

所以我的问题是我如何为整个项目生成生成文档,其中包含指向所有页面的链接的索引页面。

我尝试使用 see 标记来执行此操作,但我不知道是否可以使用它来引用另一个文件而不是文档中的另一个部分

我用这个:

输出是默认路径myluainstallationpath/doc/index.html