最近要对cocos2dx-lua的项目编写API文档, 我的想法是类似与java doc的做法,在程序中写注释,通过脚本将注释提取生成, 这样只需要维护代码中的注释就可以了调查了一下,目前支持这种方式的有Doxygen luadoc ldoc, 进一步比较网上资料决定采用ldoc方式以下是mac系统...
参考资料: http://my.oschina.net/wangxuanyihaha/blog/188909LDoc介绍: LDoc是一个Lua的文档生成工具,过去,比较常用的Lua生成文档的工具是LuaDoc,可惜作者自从2008年之后就再也没有发布过新的版本了,说明作者基本上已经放弃维护了。而....
分类:
其他好文 时间:
2015-03-15 12:11:20
阅读次数:
224
LDoc是一个Lua的文档生成工具,详细介绍见,LDoc的Github主页,但是在vim中手写注释较为复杂,然后看了下vim script,自己写了一款vim插件,用于自动生成模块注释,类型注释和函数注释,方便开发。将此文件命名为ldoc.vim放在~/.vim/plugin目录下
使用:将光标移动到需要注释的当前行,然后在命令模式下,输入LdocM,LdocT,LdocF分别进行模块注释,类型注释和函数注释,也可通过map自行映射快捷键...
分类:
系统相关 时间:
2015-01-16 01:22:29
阅读次数:
273