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）。例如（for -d）：

luadoc file.lua -d ~/Docs

据我所知，除了实际选项之外别无他法解释（因为你的代码片段解释了他们做得很好的事情）。

现在，看看你在运行时获得的错误（lua5.1：...无法打开“index.html”进行写作），我会提出一些建议。一，如果您编译了源代码，那么您可能在某处犯了错误，例如没有安装依赖项（我会感到惊讶，因为否则您根本无法创建它）。如果你这样做了，你可以尝试使用

从repos中获取它

sudo apt-get install luadoc

也将安装依赖项。这可能是个问题，因为我的luadoc工作副本在/ usr / bin中运行正常，并带有命令

./luadoc

这意味着你的luadoc是奇怪的，或者你正在做一些有趣的事情（我无法解决你所说的）。我认为你已经安装了lua5.1（考虑到错误），所以它与此无关。

我的建议是尝试运行

luadoc file.lua

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

如何在ubuntu / linux中使用luadoc？

1 个答案: