Windows下使用luaDoc生成lua文档

原文link

人员	操作	日期	备注
Conerlius	Add	2017-2-5	创建

什么是lua api文档

在书写lua代码的时候，为了方便阅读，lua的方法与变量都需要按照统一的方式书写解释，当lua文件多的时候，就需要一份能够很好传阅的文档，以方便它人查看

luadoc环境依赖

lua5.1 或以上

luadoc 如何运行

在安装lua的时候，都会把luadoc好安装在lua的安装目录下了，luadoc_start.bat文件就是一个可以执行的bat

在lua文件的目录创建一个bat，并写入以下代码

@echo on
lua.exe "%LUA_DEV%\lua\luadoc_start.lua" -d "Docs" *
pause

在windows下就可以直接生成了

如果对参数不太明白，可以使用以下命令查询

lua.exe "%LUA_DEV%\lua\luadoc_start.lua"

转载于:https://www.cnblogs.com/chiefCTO/p/6368326.html