Windows下使用luaDoc给lua生成文档

 首先需要安装lua,Windows下自然是安装Lua For Windows咯,下载地址:http://code.google.com/p/luaforwindows/
安装以后它已经包含了luadoc,所以无需我们再去下载,如果非要去下载的话,那么下载地址是:http://luadoc.luaforge.net/

然后,我们需要准备一个批处理文件,叫啥名字无所谓,我是取名叫做buildDoc.bat的,我用doxygen的时候也是叫这个名字的,以下是批处理文件的内容:

@echo on
lua.exe "%LUA_DEV%\lua\luadoc_start.lua" -d "Docs" *
pause
它做了什么呢?它调用了lua.exe执行了luadoc_start.lua这个脚本,传入的参数-d "Docs"的意思是生成的文档文件夹(输出路径),如果没有则是生成在批处理文件当前路径。第二个参数是需要生成文档的lua脚本文件列表(输入文件),不过我们可以传入了一个*,它会自动解析生成的,让它遍历当前路径的lua文件以及当前路径下面所有的子文件夹的lua文件。

有了这个批处理文件,这个时候我们就可以生成lua的文档了,只需要鼠标轻轻一点就可以了。^_^

以下给出一点lua脚本的示例:

--- 测试用表
-- @class table
-- @name p_GlobalOptions
-- @field opt1 字段1
-- @field opt2 字段2
local p_GlobalOptions = {
            opt1 = nil, 
            opt2 = nil,
}
这是一个表的简单示例,其中
-- @class table 
         是表明其类型是一个表,
-- @name 
         p_GlobalOptions是表名,
-- @field opt1 字段1
         说明第一个字段是什么。
-- @field opt2 字段2
         说明第二个字段是什么。

--------------------------------------------------------------------------------------
-- @name test
-- @description 嗯。。。这是一个测试方法的方法
-- @param param1 参数1
-- @param param2 参数2
-- @return 没有返回值哦
-- @usage test()
-- @see p_GlobalOptions 
--------------------------------------------------------------------------------------
function test(param1, param2)
end
-- @param param1 参数1
         说明参数1;
-- @return 没有返回值哦
         说明了返回值
-- @usage test()
         这里是给出一个示例代码来;
-- @see p_GlobalOptions
         可以生成一个超链接,表明这个方法和p_GlobalOptions是有关,你可以去查看。
其实还可以改改这么写:

--------------------------------------------------------------------------------------
-- @class function
-- @name test
--------------------------------------------------------------------------------------
-- @description 嗯。。。这是一个测试方法的方法
-- @param param1 参数1
-- @param param2 参数2
-- @return 没有返回值哦
-- @usage test()
-- @see p_GlobalOptions 
--------------------------------------------------------------------------------------
即,表明其类型是一个function,名字叫做test。
@class有三个参数:function, table 和 module。分别表示是:方法,表和模块。

具体文档请参见: http://luadoc.luaforge.net/manual.html

-------------------------------------------------------------------------------------------------------------
来点闲话,最近工作已经放到了使用lua做开发上面去了,没办法,广州这边的游戏公司基本上都是用脚本做大部分事情。
至于为什么要这样倚重脚本,无非就是:出于人员培训的考虑,出于快速开发的考虑……
没有复杂的数据类型,甚至于其实根本不用管数据类型是什么,因为它是一个弱类型的语言……
只有一个数据结构:table,可以做变长数组,可做hash表,甚至用于模拟Class……
你可以不用声明类型,它可以叫做“使用即声明”。你一不小心把名字写错了,解释器还不报错:这是合法的。想要捕获这种错误,还需要一些技巧性的解决方法。
没有像VS那样好用的IDE(因为我自始自终都在用着这个让人惰性化的工具),虽然有UEStudio、EditPlus、NotePad++、SciTe、GVIM、LuaEdit,甚至于Eclipse也可以用,但是,始终不觉得好用。
调试起来也不大方便,不过还好有Decoda这个支持远程调试器的好东西,至少还有的用。
不管怎样,
弱类型有弱类型的好处,实现委托不是那么困难的事情了,也不需要使用像boost:any这样的玩意了。C++中所需要思考的东西一下子不再需要去烦扰了。
不过我却依然快不起来,语言上所要困扰的东西虽然少了许多,但是习惯它总是需要时间的。
而且,融入新团队,沟通,这些开发中的成本始终是存在的,不管用什么编程语言,不管做什么项目,不管在什么公司……

时间: 2024-10-30 04:42:36

Windows下使用luaDoc给lua生成文档的相关文章

Ruby on rails开发从头来(windows)(十八)-自动生成文档

到此,我们这个购物车的实现就完成了,下面我们可以利用ruby里的Rdoc来给我们的程序生成文档,和dotnet,java,python等一样,Rdoc可以把我们代码里类和方法声明前面的注释提取出来生成文档. 对于我们的depot程序,我们在rails的命令行里运行rake appdoc命令,如图: 开发从头来(windows)(十八)-自动生成文档-ruby on rails"> 完成以后,可以在depot\doc目录下看到刚才生成的文档,打开index.html,看到下面的内容:

phalapi-入门篇4(国际化高可用和自动生成文档)

phalapi-入门篇4(国际化高可用和自动生成文档) 前言 先在这里感谢phalapi框架创始人@dogstar,为我们提供了这样一个优秀的开源框架. 在本小节主要讲解如何使用phalapi框架自带的国际化和文档自动生成,以及这样做可以的优点和好处和能解决哪方面的问题 附上: 官网地址:http://www.phalapi.net/ 开源中国Git地址:http://git.oschina.net/dogstar/PhalApi/tree/release 1. 国际化 说道国际化大家应该不陌生

探讨:如何使用PhpDocumentor生成文档_php技巧

命令行方式: 在phpDocumentor所在目录下,输入phpdoc –h会得到一个详细的参数表,其中几个重要的参数如下:-f 要进行分析的文件名,多个文件用逗号隔开-d 要分析的目录,多个目录用逗号分割-t 生成的文档的存放路径-o 输出的文档格式,结构为输出格式:转换器名:模板目录. 例如:phpdoc -o HTML:frames:earthli -f test.php -t docs Web界面生成 在新的phpdoc中,除了在命令行下生成文档外,还可以在客户端浏览器上操作生成文档,具

java web-Java web在线动态生成文档

问题描述 Java web在线动态生成文档 Java web如何动态的向在线编辑的文档中插入数据,已经用word控件在线显示,通过后台操作,把数据插入控件的新建文档,我用的是web office 控件

前端那点事儿——Tocify自动生成文档目录

今天偶然间看到文档服务器有一个动态目录功能,点击目录能跳转到指定的位置:窗口滑动也能自动更新目录的焦点. 效果 框架 原来使用的是一个开源的jquery-ui控件--tocify.js,它可以遍历页面,把指定的DOM元素抽取出来形成目录. 下载地址参考gitub : [gfranko/jquery.tocify.js] 开发者可以直接下载zip包使用,压缩包里面的内容包括: demos 演示页面(里面有一个google的链接,访问会超时,去掉即可) images 可以忽略 libs 额外使用的文

sphinx将python的注释生成文档例子

安装 sudo pip install sphinx 初始化 进入你代码所在的目录,输入以下内容 sphinx-quickstart 会出来一系列要选填的东西,按照我的填入就可以了 Welcome to the Sphinx 1.2.3 quickstart utility. Please enter values for the following settings (just press Enter to accept a default value, if one is given in

Python如何快速从注释生成文档

作为一个标准的程序猿,为程序编写说明文档是一步必不可少的工作,如何才能写的又好又快呢,下面我们就来详细探讨下吧. 今天将告诉大家一个简单平时只要注意的小细节,就可以轻松生成注释文档,也可以检查我们写的类方法引用名称是否重复有问题等. 一看别人专业的大牛们写的文档多牛多羡慕,不用担心我们可以让python为我们生成基本满足的说明文档,一来可以提高代码整体阅读性,二来可以将代码的整体结构看着也更清晰,这样在交接的时候可以省很多麻烦,其它同事在接手你工作的时候也不会一行行去问你这是什么那是什么的,因为

javascript注释生成文档的代码

后来发现这样的文档很不方便查看, 且又听我们BOSS说phper能生成他们的文档, 我在想js会不会也有一个呢, 于是...你懂的... 通过@广州♂lxrmido 知道了 jsdoc, 于是 github上down下来; 附地址: https://github.com/jsdoc3/jsdoc 他可以让你的js生成HTML文档,如:  代码如下 复制代码 /**  * 打开新窗口  * @param {string} [url] 连接  * @param {object} [options]

请问利用 Javadoc 工具生成文档时,如何将类名作为生成的文档的 <title>

问题描述 在 Eclipse 中生成一个项目的 Javadoc. [menu] Project -> Generate javadoc...如果在向导的第三步的 "Extra javadoc options" 文本框中指定 "-windowtitle xxxxxxx", 则生成的每个类的文档的 <title> 都会是固定 xxxxxxx.现在请问如何像那些著名的大型项目生成的 javadoc 那样,每个类的文档的 <title> 都和该