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

Question

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

luadoc
Usage: /usr/bin/luadoc [options|files]
Generate documentation from files. Available options are:
  -d path                      output directory path
  -t path                      template directory path
  -h, --help                   print this help and exit
      --noindexpage            do not generate global index page
      --nofiles                do not generate documentation for files
      --nomodules              do not generate documentation for modules
      --doclet doclet_module   doclet module to generate output
      --taglet taglet_module   taglet module to parse input code
  -q, --quiet                  suppress all normal output
  -v, --version                print version information

Answer 1

首先，我对 Luadoc 没有什么经验，但对 Ubuntu 和 Lua 有很多经验，所以我的所有观点都基于我刚刚完成的 luadoc 知识和快速安装。据我所知，Luadoc 是一个 Lua 库(因此也可以在 Lua 脚本和 bash 中使用)。要制作文档(在 bash 中)，您只需运行

luadoc file.lua

(其中 file 是您要为其创建文档的文件的名称)

选项 -d 和 -t 用于选择您要放置文件的位置以及您要使用的模板(我对此一无所知，恐怕 :P)。例如(对于 -d):

luadoc file.lua -d ~/Docs

据我所知，关于实际选项几乎没有其他解释(因为您的代码片段解释了它们做得很好的地方)。

现在，看看您在运行时遇到的错误(lua5.1:...无法打开“index.html”进行写入)，我会提出一些建议。第一，如果你编译了源代码，那么你可能在某个地方犯了错误，比如没有安装依赖项(我会对此感到惊讶，否则你根本无法做到)。如果你这样做了，你可以尝试从 repo 中获取它

sudo apt-get install luadoc

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

./luadoc

这意味着您的 luadoc 很奇怪，或者您正在做一些有趣的事情(我无法从您所说的内容中得出结论)。我假设您已经安装了 lua5.1(考虑到错误)，所以这与此无关。

我给你的建议是尝试运行

luadoc file.lua

在 file.lua 的目录中有任何旧的 lua 文件(尽管最好是至少有一点数据的文件)并查看它是否在同一文件夹中生成一个 index.html(不要使用 -d 更改目录，用于测试目的)。如果那不起作用，则使用 apt-get 从存储库重新安装它。如果这样做并尝试 luadoc file.lua 不起作用，则回复错误，因为更大的错误(可能)。