如何在Ubuntu/Linux中使用Luadoc？

2013-7-6 10:21:45
收藏：0
阅读：105
评论：1

如标题所述，如何在Ubuntu / Linux中使用Luadoc？我使用批处理文件在Windows中生成了文档，但在Ubuntu中没有成功。有什么想法吗？

luadoc
用法：/usr/bin/luadoc [options|files]
从文件生成文档。可用选项为：
  -d path                      输出目录路径
  -t path                      模板目录路径
  -h, --help                   打印此帮助并退出
      --noindexpage            不生成全局索引页面
      --nofiles                不为文件生成文档
      --nomodules              不为模块生成文档
      --doclet doclet_module   生成输出的doclet模块
      --taglet taglet_module   解析输入代码的taglet模块
  -q, --quiet                  抑制所有正常输出
  -v, --version                打印版本信息
点赞
用户2448828
用户2448828

首先，我对 Luadoc 的经验很少，但对 Ubuntu 和 Lua 有很多经验，因此我基于这方面的知识和我刚刚安装的 luadoc 快速论述所有的点。据我所见，Luadoc 是一个 Lua 库（因此也可以用于 Lua 脚本以及 bash）。要生成文档（在 bash 中），只需运行

luadoc file.lua

（其中 file 是您想要创建文档的文件的名称）

选项 -d 和 -t 用于选择您想要放置文件的位置和要使用的模板（对此我不太清楚，抱歉 :P）。例如（对于 -d）：

luadoc file.lua -d ~/Docs

据我所见，关于实际选项，（因为您的代码片段已经很好地解释了它们的作用）没有其他需要解释的了。

现在，看着您运行时得到的错误（lua5.1: ... could not open "index.html" for writing），我建议您尝试一些事情。首先，如果您编译了源代码，则可能某个地方出错了，例如未安装依赖项（我感到惊讶，因为否则您根本就不可能将其制作出来）。如果您这样做了，请尝试从存储库中获取它：

sudo apt-get install luadoc

这也将安装依赖项。这可能是问题所在，因为我工作的 luadoc 副本可以通过命令/ usr / bin with 运行良好。

我建议您尝试在 file.lua 目录下运行

luadoc file.lua

并使用任意旧的 Lua 文件（虽然最好至少有一点数据）以及查看是否在相同文件夹中生成了 index.html（不要使用 -d 更改目录，以测试为目的）。如果这不起作用，然后通过 apt-get 从存储库重新安装。如果这样做并尝试运行 luadoc file.lua 仍然不起作用，请回复错误，因为可能出现了更大的问题。

2013-07-14 19:22:12

作者:

用户2554162

用户2554162
推荐文章