Lua区分公有私有接口
(金庆的专栏 2017.8)
Lua语言没有提供public, private的概念,所有模块或类中的接口都是公有的。
可以通过注释来区分公有私有接口。
ldoc 提供了一个 @section 标签,可用作此功能
--- Test module.
-- @module my_mod
local M = {}
--- Public functions
-- @section public
--- foo.
-- @int a a test input
-- @treturn int result
function M.foo(a)
return a + 1
end
--- Private functions
-- @section private
--- goo.
-- @int a a test input
-- @treturn int result
function M.goo(a)
return a + 2
end
return M
(金庆的专栏 2017.8)
Lua语言没有提供public, private的概念,所有模块或类中的接口都是公有的。
可以通过注释来区分公有私有接口。
ldoc 提供了一个 @section 标签,可用作此功能
--- Test module.
-- @module my_mod
local M = {}
--- Public functions
-- @section public
--- foo.
-- @int a a test input
-- @treturn int result
function M.foo(a)
return a + 1
end
--- Private functions
-- @section private
--- goo.
-- @int a a test input
-- @treturn int result
function M.goo(a)
return a + 2
end
return M
ldoc 生成文档后是这样的: