ldoc version

ldoc, a documentation generator for Lua, vs 1.4.6

模块注释

变量

Global_Variable.lua

--- 全局变量 module

--- db_host [ hostname | ip ] 
g_db_host='xxx.xxx.xxx.xxx'

--- db_port
g_db_port='5432'

--- db_user
g_db_user='gpadmin'

--- db_pass
g_db_pass='xxxxxx'

--- db_type [ postgresql | mysql ] 
g_db_type='postgresql'

效果

20210420_lua_i.png

类

Global_Class.lua

--- 全局类 module
--- @classmod cls_person 
cls_person = {}
--- 
-- 参数说明: 名称
cls_person.Name ="名字:lua"
---
-- 函数说明: 人在说话
-- @usage cls_person:Speak()
cls_person:Speak=function()
    print("人在说话")
end
---
-- 函数说明: 人在走路
-- @usage cls_person:Walking()
function cls_person:Walking()
    print("人在走路")
end

效果

20210420_lua_ii.png