安装Ldoc:为Lua API接口编写文档

Ldoc是一个类似doxygen的文档生成工具,doxygen功能更强大但是不支持lua语言,所以需要专门的Ldoc工具来编写Lua文档:https://github.com/stevedonovan/LDoc

在官方的README.md页面中对安装过程描述很含糊,以至于弄了不少时间(真不知道是自己理解能力有问题还是他们表达能力有问题,无语)。

不过,我发现程序员应该知道自己要装的工具用来做什么的。比如这个Ldoc是其实要装一个叫luarocks的东西,这是第三方模块管理工具(我发现这个和Linux的apt-get工具很类似,这里Unix系程序员的哲学思想就体现出来了:一个程序只做一件事,并且要好。组合小程序完成复杂任务。),通过它可以安装各种第三方模块给lua脚本调用,并且对依赖的模块也会自动进行安装,很方便。

官方只是提到了这个东西,并没有教我怎么去用,后来运行Ldoc也出现很多问题。主要是因为我想修改luarocks中Lua的5.1版本为自己编译的5.3版本,结果尝试了很久都修改不了,网上谷歌一下都是Linux环境下的解决方案,而且那些配置文件很多都是针对Linux环境,对于一个Windows程序员来说看的我有点晕了。本来还想放弃的,后来不忍心再折腾一下,追本溯源,一开始执行ldoc的错误是在_G.pcall(_G.require,'lfs')这行调用失败,后来我仔细检查了路径没有问题!然后我想直接require一下,结果发现一个提示:multiple Lua VMs detected,网上说这是因为lua.exe静态链接,而第三方库也是静态链接,结果出现了两个不同的Lua环境,应该使用动态链接生成lua.exe。然后我就看回5.1版本的Lua.exe,发现是动态链接的!然后我马上去Lua官网下载了一个编译好的5.3动态链接版本。真的好了!激动!(其实中间还经历了很多曲折的过程,试了很多种可能,这里就不列出来了,总之追本溯源是解决这类配置问题的最佳方法,而不是一味的搜索

好了,整理一下方法:

在luarocks的install.bat修改下面几行配置,指向你想用的Lua版本(必须是动态链接版本):

vars.LUA_INTERPRETER = "C:\\document\\Lua\\lua-5.3.3-official\\bin"
vars.LUA_PREFIX = nil
vars.LUA_BINDIR = "C:\\document\\Lua\\lua-5.3.3-official\\bin"
vars.LUA_INCDIR = "C:\\document\\Lua\\lua-5.3.3-official\\include"
vars.LUA_LIBDIR = "C:\\document\\Lua\\lua-5.3.3-official\\bin"
vars.LUA_LIBNAME = "lua"
vars.LUA_VERSION = "5.3"

接着在同目录下cmd运行install就行了。
安装无错后,再运行Luarocks install ldoc就会自动安装ldoc和其依赖的PenLight库和LuaFileSystem库(如果没有自动安装依赖库,自己手动再Luarocks install 库名称)。安装过程中是要用VS进行编译的,可能会出现找不到cl.exe,看http://blog.csdn.net/sinat_24229853/article/details/52722865这里的方法进行配置即可。直至安装成功,cmd里输入ldoc出现帮助参数就表明安装成功了。最后,将ldoc所在的目录加进Path环境变量,方便在各处运行。

这里写图片描述

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值