金庆的专栏

  C++博客 :: 首页 :: 新随笔 :: 联系 :: 聚合  :: 管理 ::
  334 随笔 :: 0 文章 :: 454 评论 :: 0 Trackbacks
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

ldoc 生成文档后是这样的:
posted on 2017-08-18 18:51 金庆 阅读(24) 评论(0)  编辑 收藏 引用 所属分类: 5. 软工与管理2. 网游开发

只有注册用户登录后才能发表评论。
【推荐】超50万行VC++源码: 大型组态工控、电力仿真CAD与GIS源码库
网站导航: 博客园   IT新闻   BlogJava   知识库   博问   管理