如何在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“来写)，我有一些建议。其一，如果您编译了源代码，那么您可能在某个地方犯了错误，比如没有安装依赖项(我会对此感到惊讶，因为否则您根本无法做到这一点)。如果您这样做了，您可以尝试使用以下命令从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不起作用，那么请回复错误，因为有更大的错误(可能)。