1． 安装LuaForWindows
这个lua工具可能很多人都装了，测试方法，cmd打开后输入lua回车，产生如下界面即已经安装
1.1 将lua的安装目录配置到path环境变量中。
如Lua默认安装，目录为C:\Program Files(x86)\Lua\bin;
Windows菜单中右键计算机-》属性-》高级系统设置-》高级-》环境变量-》path里面最后添加 C:\Program Files (x86)\Lua \bin; (切记与前一项用分号隔开)
最后启动cmd，直接打lua回车，出现上图就说明lua环境安装成功。
2、使用LuaDoc
在需要生产文档的目录，如scripts\app\data中，shift加右键，选择在此处打开命令行
在cmd中输入:
Luadoc –d 指定文档输出路径 需要生产的文件
如生成整个文件夹的文档到桌面的test文件夹中，在cmd中输入
Luadoc –d C:\Users\caomx\Desktop\test *
即可。生产的文件夹中运行index.html就可以看到生成的LuaDoc文档网页。
3、Lua中的注释规范
--- 测试用表
-- @class table
-- @name testTable
-- @field testA 测试字段A
-- @field testB 测试字段B
testTable =
{
testA = nil,
testB = nil,
}
--- 测试函数
-- @param a 参数a
-- @param b 参数b
-- @return 返回1
-- @usage testFun(1, 2)
-- @see testTable
function testFun(a, b)
return 1
end
上图为举例代码生成的文档格式，具体注释视实际情况而定。
3.1 一个函数或者表格的前面使用 --- +说明文字注释
3.2 表格使用@class table + @name 表名 开头，@field 字段名 字段说明 来表示内部成员变量。
3.3 函数使用@function 函数名开头，@param 表示参数，@return表示返回值，@usage表示使用方法，这些参数按实际需求写注释。
@see 表示链接跳转，表示理解此函数还需要看的其他地方
项目中想整理一下Lua编码注释问题，形成文档便于新人理解和查阅。于是研究了下LuaDoc，自行整理了上面这篇博文，填坑一个。