首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

使用Ldoc给Lua生成文档

Ldoc介绍   Ldoc是一个Lua的文档生成工具,过去,比较常用的Lua生成文档的工具是LuaDoc,可惜作者自从2008年之后就再也没有发布过新的版本了,说明作者基本上已经放弃维护了。...而Ldoc则是一直在更新中,所以现在选择Ldoc来给Lua生成文档是更好的选择,Ldoc的Github主页。   ...Ldoc还有一些其他的LuaDoc不具备的优点,比如 Ldoc可以生成Markdown格式的文档. Ldoc生成的文档也也更加美观等等。...其逻辑是由lua代码编写,方便自己修改和理解源码   Ldoc虽然可以针对某个lua文件生成文档,但是更加推荐的方式是通过config.ld来对需要生成文档的项目进行配置,之后,只要在config.ld...添加了项目名称后,它生成的文档样式如下:   简单使用,安装配置完毕直接: ldoc -v xxx目录 即可在config.ld同目录下生成doc文件夹,内部有index.html,打开即可看到生成的文档

1.5K60
您找到你想要的搜索结果了吗?
是的
没有找到

Lua生成的LDoc文档注释规范

@classmod 和 @module 类似, 但是用来描述 class, 用这个标签后, 生成的文档中 Module 文字会变成 Class....@script 和 @module 类似, 生成的文档中 Module 文字会变成 Script....以上几个标签都是project-level, 意味着每个文件中只能包含它们其中的一个, 否则生成时就会提示 Module already declared! 错误....生成出来的文档是用 Or 来列出这些不同的返回值的. config.ld 的字段说明 ldoc 运行时有一堆参数可以传递, 在终端中去做比较麻烦, 修改也不太方便....其实 config.ld 就是一个lua文件, 填写时需要遵循lua语法. file 可以是一个文件名或者目录名, 如: file = ‘test.lua’. file 也可以是一个table, 这时里面可以填写文件数组或目录数组

3.7K10

生成lua的静态库.动态库.lua.exe和luac.exe

前些日子准备学习下关于lua coroutine更为强大的功能,然而发现根据lua 5.1.4版本来运行一段代码的话也会导致 “lua: attempt to yield across metamethod...于是就想使用5.2以上的版本试试;windows下没有5.2以上的版本,又不愿意使用VS编译出lua.exe;就在网上搜索下了关于使用命令行生成lua的静态库.动态库.lua.exe和luac.exe资料...:现整理如下: 将下载的lua源码解压,在src目录下 打开VC命令行提示窗口 执行如下代码即可(针对5.1): 生成~~~ 静态库: del *.obj liblua.lib cl -c -nologo...loslib.c ltablib.c lstrlib.c loadlib.c linit.c link -link -dll -out:liblua.dll -verbose:lib *.obj 生成...link -link -out:lua.exe -verbose:lib *.obj 生成~~~ luac.exe: del *.obj luac.exe cl -c -nologo -O2

3.3K110

Lua菜鸟①】初识Lua

简介 Lua 是一种轻量小巧的脚本语言,用标准C语言编写并以源代码形式开放, 其设计目的是为了嵌入应用程序中,从而为应用程序提供灵活的扩展和定制功能。...可扩展: Lua提供了非常易于使用的扩展接口和机制:由宿主语言(通常是C或C++)提供这些功能,Lua可以使用它们,就像是本来就内置的功能一样。...独立应用脚本 Web 应用脚本 扩展和数据库插件如:MySQL Proxy 和 MySQL WorkBench 安全系统,如入侵检测系统 以下使用window环境,适合我这样的菜鸟: 第一个Lua程序,...环境配置 大家可以在Lua的官网下载window系统所需要的编译器,然后配置环境即可 将lua命令加入到path中即可,这样就可以利用VS Code直接运行 ? 然后就是给世界打招呼了 ?...菜鸟终于可以写Lua了,明天继续!

2.9K90

Lua语言_lua基本语法

1、Lua简介 1.1 Lua是什么 1.2 特性 1.3 应用场景 2、Lua的安装 3、入门程序 4、Lua的基础语法 4.1 注释 4.2 定义变量 4.3 Lua中的数据类型 4.4 流程控制...4.5 循环 4.6 函数 4.7 表 4.8 模块 1、Lua简介 1.1 Lua是什么 Lua [1] 是一个小巧的脚本语言。...此时再执行lua测试看lua是否安装成功 [root@localhost ~]# lua Lua 5.1.4 Copyright (C) 1994-2008 Lua.org, PUC-Rio 3、入门程序...执行命令 lua hellp.lua 输出为: Hello 效果如下: 4、Lua的基础语法 lua有交互式编程和脚本式编程。 交互式编程就是直接输入语法,就能执行。...Lua 交互式编程模式可以通过命令 lua -i 或 lua 来启用: lua -i 如下图: (2)脚本式编程 我们可以将 Lua 程序代码保持到一个以 lua 结尾的文件,并执行,该模式称为脚本式编程

3.1K20

lua

游戏里面用lua来热更新的 redis的默认方法也是lua(我觉得是因为和nosql很搭) 变量 全局变量直接使用的时候为nil 数组下标从0开始(不推荐)a = {[0]="123","32",..."23"}; 支持多返回值,多个同时赋值,只需要一个时候使用哑元_ 尽量避免一个下划线开头+大写字母 ---[[可以注销掉块注释 type函数永远返回一个字符串 lua将false和nil视为假,将0和空字符串视为真...LUA对于小于1014的数字用双精度没有四舍五入的浮点误差,合法的数字写法:4,0.4,4.58e-3,0.3e12,5e+20 Lua的字符串是只读的,\表达数值转义,[[ ]],[===...(Lua4.0 以前在度数下工作。)你可以使用 deg 和 rad 函数在度和弧度之间转换。...->OnInitOK()->CtrlManager.Init() Define.Lua:"xxx=xxxCtrl" GameManager.Lua:ctrl:Awake() LayerPanel

2.2K20

Lua连续教程之Lua反射

如果foo是一个普通的Lua函数,则为“Lua”;如果是一个C函数,则为“C”;如果是一个Lua语言代码段的主要部分,则为“main”。...请注意,由于函数在Lua语言中是第一类值,因此函数既可以没有名称也可以有多个名称。Lua语言会通过检查调用该函数的代码来看函数是如何被调用的,进而尝试找到该函数的名称。...Lua语言按局部变量在函数中的出现顺序对它们进行编号,但编号只限于在函数当前作用域中活跃的变量。...访问非局部变量 测试库还提供了函数getupvalue,该函数允许我们访问一个被Lua函数所使用的非局部变量。...这是因为,在函数F处于活动状态时,Lua语言可以通过分析正在调用函数F的代码来找出函数F的名称。

2.5K10

Lua连续教程之Lua线程和状态

Lua语言同时支持这两种方案。Lua语言的线程是协作式的,因此可以避免因不可预知的线程切换而带来的问题。另一方面,Lua状态之间不共享内存,因此也为Lua语言中实现并行化提供了良好基础。...例如,考虑如下的代码: lua_State *L1 = lua_newthread(L); lua_pop(L,1); lua_pushstring(L1,"hello"); 调用lua_pushstring...(L1,1,1); lua_xmove(L1,L,1); 函数lua_xmove可以在同一个Lua状态的两个栈之间移动Lua值。...因此,我们需要用到函数lua_resume: int lua_resume (lua_State *L,lua_State *from, int narg); 要启动一个协程,我们可以像使用lua_pcall...*L1 = lua_newthread(L); lua_getglobal(L1,"foo1"); lua_pushinteger(L1,20); lua_Resume(L1,L,1); 调用lua_resume

2.7K20
领券