【问题标题】:How to use LuaDoc with LuaForWindows如何在 LuaForWindows 中使用 LuaDoc
【发布时间】:2013-02-22 21:45:19
【问题描述】:

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

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

有什么帮助吗? 谢谢

【问题讨论】:

  • 打开命令提示符/powershell; luadoc_start.bat filename.lua
  • 坦克,我得到了一个正确生成的 doc 文件,但是如何为整个项目做呢?我知道有一个 -d 参数,但我不确定如何使用它,我的尝试都没有成功。
  • 你的意思是遍历所有的lua文件?
  • 我已经安装了 lua 并且我得到了 luadoc_start 但是当我运行它时我得到一个错误是否需要任何依赖或我应该做任何额外的工作?
  • 你是怎么拿到那个文件的?我已经用 luarocks 安装了所有东西,但我根本不知道如何运行这个东西(stackoverflow.com/questions/41203830/how-to-run-luadoc

标签: documentation lua documentation-generation luadoc


【解决方案1】:

Lua For Windows中使用luadoc,命令如下:

luadoc_start.bat path\to\lua\file\name.lua

这将在命令提示符窗口或 powershell 中完成。

我得到一个 doc 文件来正确生成 但是如何为整个项目生成它?我知道有一个 -d 参数,但我不确定如何使用它,我的尝试都没有成功。

对于此任务,您需要编写一个 shell 脚本。这是一个小的 脚本。

$files = Get-ChildItem .\
foreach( $file in $files ) {
    luadoc_start.bat "$file"
}

在哪里,你必须cdpath\to\lua\file 目录并运行这个PS1 文件。

【讨论】:

  • 所以,ExecutionPolicy 事情有点乱,但我让它工作了!我很惊讶 LuaDoc 没有为整个层次结构生成文档的内置方法,但无论如何谢谢大家。
  • 有什么机会可以帮助我here
【解决方案2】:

只需将pause 行附加到luadoc_start.bat,您就会看到帮助屏幕。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2014-11-02
    • 2021-06-04
    • 2017-01-30
    相关资源
    最近更新 更多