战魂小筑

讨论群:309800774 知乎关注:http://zhihu.com/people/sunicdavy 开源项目:https://github.com/davyxu

   :: 首页 :: 新随笔 :: 联系 :: 聚合  :: 管理 ::
  257 随笔 :: 0 文章 :: 506 评论 :: 0 Trackbacks

试用了下lua专属的注释生成文档工具luaDoc,基本模式和doxygen差不多,不过感觉更简单一些

1. 前期准备工作,及编译方法

luaDoc需要依赖luaFileSystem和luaLogging,因此我使用的是一个整合包http://luaforwindows.luaforge.net/

要开始使用时,在5.1\lua下找到luadoc_start.lua文件,这个文件就是luadoc的启动文件

找到你需要制作的lua文件的目录制作一个类似这样的bat

lua "d:\Program Files\Lua\5.1\lua\luadoc_start.lua" xxx.lua

这里注意:lua是已经注册到系统路径的,如果你没有安装整合包,需要手动加一下

如果需要批量生成,只需要用*.lua既可以

生成出来的网页文件放置在你的源码目录,用index.html开始查看

 

2. 让luaDoc识别程序里的注释

看下基本注释结构:

--- 继承于某table的属性及函数
-- @param selfclass 某table
-- @param parentclass 需要继承的table
-- @return 继承后的类
-- @usage local _widgetnotebox =  _Inherit( {}, WIDGET_BASE )
function _Inherit( selfclass, parentclass )
    if not parentclass then
        error("parentclass null", 2 )
    end
    return setmetatable( selfclass, 
    {
    __index = function( t, k )
        local ret = parentclass[k]
        selfclass[k]= ret
        return ret
    end
    
    } )
end
luaDoc从---开始识别你的函数注释,这个被放置于函数主要说明中
@param用作参数说明,selfclass标记是哪个参数的说明
@return说明返回值
@usage就是一些例子
posted on 2009-07-15 17:47 战魂小筑 阅读(761) 评论(0)  编辑 收藏 引用 所属分类: 脚本技术

只有注册用户登录后才能发表评论。
网站导航: 博客园   IT新闻   BlogJava   知识库   博问   管理