LuaDoc自动生成注释工具使用说明文档

最新推荐文章于 2024-05-29 20:59:31 发布
最新推荐文章于 2024-05-29 20:59:31 发布
阅读量2.9k 收藏
点赞数
文章标签： LuaDoc 注释规范
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/caomx0125/article/details/79424608
版权
本文档介绍了如何安装和使用LuaDoc工具自动生成注释文档，并详细阐述了Lua编程中的注释规范，包括函数和表格的注释格式，帮助开发者更好地理解和维护代码。
摘要由CSDN通过智能技术生成

1． 安装LuaForWindows

这个lua工具可能很多人都装了，测试方法，cmd打开后输入lua回车，产生如下界面即已经安装

1.1 将lua的安装目录配置到path环境变量中。

如Lua默认安装，目录为C:\Program Files(x86)\Lua\bin;

Windows菜单中右键计算机-》属性-》高级系统设置-》高级-》环境变量-》path里面最后添加 C:\Program Files (x86)\Lua \bin; (切记与前一项用分号隔开)

最后启动cmd，直接打lua回车，出现上图就说明lua环境安装成功。




2、使用Lu

最低0.47元/天 解锁文章
暮雨天澜
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
cocos2dx-lua绑定之代码编辑器
wtyqm的专栏
07-16 1万+
享受脚本语言灵活、更新方便、免于编译的好处，但也不能忍受离开那些方便的IDE特性（跳转、自动完成）。 搜集整理了一些使用Sublime Text编辑cocos2dx-lua工程的资料，希望能给大家带来帮助。
Lua脚本自动生成APK包
09-22
主要介绍了Lua脚本自动生成APK包,本文脚本适用于cocos2dx+lua的项目,需要的朋友可以参考下
自动生成查找组件的lua代码
Jeremy201500的博客
05-20 364
　　本篇主要解决的问题是使用lua脚本编写unity业务逻辑时，自动生成一些查找组件及绑定控件事件的lua代码！ 　　现在很多unity项目都是用ulua作为热更新解决方案，因此需要用lua来写相关的逻辑，经常会用到的就是在lua中查找某个对象，尤其是写一些UI逻辑！ 　　比如在Login界面中有登陆按钮、记住密码勾选框，在lua中获取这两个按钮可能的lua代码写法就是： a1 s...
EmmyLua注释详解
最新发布
wangjun_huster的博客
05-29 881
字段 —@field [public|protected|private] field_name FIELD_TYPE[|OTHER_TYPE] [@comment]–泛型 —@generic T1 [: PARENT_TYPE] [, T2 [: PARENT_TYPE]]–参数 —@param param_name MY_TYPE[|other_type] [@comment]–类型 —@type MY_TYPE[|OTHER_TYPE] [@comment]
利用Ldoc生成lua的doc文档
yeputi_WK的博客
09-28 1078
转处 【原文链接】 如果下面操作出现无法执行lua代码的，需要先安装lua。详见下文第四点。 一、安装LuaRocks 1.1、下载luarocks 下载地址为：http://luarocks.org/releases/luarocks-2.2.1.tar.gz 或者http://luarocks.org/releases/ 1.2、解压到本地磁盘 1.3、...
Windows下使用luaDoc给lua生成文档
weixin_34380296的博客
10-09 272
首先需要安装lua，Windows下自然是安装Lua For Windows咯，下载地址:http://code.google.com/p/luaforwindows/安装以后它已经包含了luadoc，所以无需我们再去下载，如果非要去下载的话，那么下载地址是：http://luadoc.luaforge.net/。然后，我们需要准备一个批处理文件，叫啥...
C#窗体应用程序实现cocos2dx json文件自动生成lua文件
aschen518的博客
12-10 878
文件解析部分： using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Windows.Forms; using System.IO; namespace WindowsFormsApplication3 {     class G
C#垃圾代码生成,包含说明文档和使用工具
02-11
在GitHub找到的一位大佬写的用Lua脚本生成C#垃圾代码的工具; 自己研究了下,然后找了个运行Lua的免费IDE,把整个流程跑了下,实测可用; 推荐给各位,我又简单写了个使用流程和说明; 附上Github的链接: ...
lua脚本实现自动生成APK包
09-22
上次用了纯bat写了个脚本生成APK包，感觉bat扩展性和语法差的令人发指，这次用lua重写了一个脚本，适用于cocos2dx+lua的项目，小伙伴们来参考下吧。
lua调用Unity优化工具（自动生成代码）
12-02
lua调用Unity对象资源时，避免拿到Unity的对象，而是拿到...本工具会自动生成lua页面的代码和lua页面控制器的代码，节省开发时间。但是请注意这里的UI使用的是NGUI，如果UGUI 使用需要自行修改。并且路径也需要自行修改
Lua多行注释和取消多行注释的方法
09-21
- **使用文档注释**：对于函数和模块，可以使用多行注释来创建文档字符串，方便自动生成API文档，如使用`--[[=begin]]`和`--]=]`。 总之，掌握Lua的多行注释技巧并遵循良好的注释习惯，能显著提升代码的可维护性和...
快速生成某个lua文件对外的api
08-12
快速生成某个lua文件对外的api
rust_lua_ffi:自动生成Rust和Lua粘合代码以实现无缝FFI互操作
05-22
Lua到Rust FFI代码生成 激励榜样 锈 #[derive(LuaMarshalling)] pub struct A { string: String , integer: i32 , } pub mod extern_ffi { pub fn make_a (string: & str , integer: i32 ) -> A { A { string: string. to_owned (), integer, } } pub fn describe (a: A) -> String { format! ( "A: {:?}" , a) } } a local example = require ( ' rust-example
最好用Lua编辑器, 自动补全中带注释
06-20
增加功能: 1、增加接口注释功能 wnd:GetName /*返回窗口名字，无参数*/ 1] 提供自定义关键字 [2] 提供自定义接口自动提示 [3] 提供关键字,接口颜色自定义 [4] 提供Lua语法检查和编译,调试 [5] 接口快速定位 [6] 广泛适用使用Lua脚本的游戏(如吃惑,魔兽,Lae)插件编辑.
删除 Lua 中注释以及空行
05-23
1.删除 lua 脚本中的注释&&多余的空格/空行 2.输出格式可选单行，压缩脚本大小
aws-sdk-lua：自动生成用于Lua的AWS开发工具包
02-03
适用于Lua的AWS开发工具包（测试版） 适用于Lua的非官方AWS开发工具包，可用于LuaJIT和Lua 5.1及更高版本。 该SDK已在生产环境中使用，特别是在GameLift中，但尚未测试其他一些服务。 有关发行说明，请参阅 。 ...
不用写注解就可以生成文档的工具，你晓得不？
程序员麦冬的博客（公众号同名）
08-21 374
今天给大家安利一款接口文档生成器——JApiDocs。不用写注解，就可以生成文档的工具，你心动了吗？ 下面我们一起来看看如何使用！ 一、添加依赖 <dependency> <groupId>io.github.yedaxia</groupId> <artifactId>japidocs</artifactId> <version>1.3</version> </dependency> 二、配置生成参
Lua 读表代码，自动生成字段名字
weixin_30598225的博客
07-25 129
表格格式为 INT STRING INT INT INT INT INT Id Desc Type SceneId OpenId MaxPliesp ClearancePlies 0 第1关 0 1 -1 110 80 1 第2关 0 1 0 120...
Lua生成的LDoc文档注释规范
一入編程深似海!
03-03 1291
标签 @module 模块, 一般一个文件就是一个模块. @classmod 和 @module 类似, 但是用来描述 class, 用这个标签后, 生成的文档中 Module 文字会变成 Class. @submodule 如果一个模块的内容被分到了好几个文件中, 那么就可以再其他文件中用 submodule 来定义, 后面跟上master module的名字. @script 和 @modu...
lua 生成注释文档
05-31
Lua 的文档注释可以使用一些工具来生成文档，例如 LDoc、LuaDoc 等等。这些工具通常会读取 Lua 代码中的注释，提取其中的标记和信息，然后生成 HTML、Markdown 或其他格式的文档。下面是一个使用 LDoc 工具生成文档的示例： 1. 安装 LDoc 工具。可以使用 LuaRocks 来安装： ``` luarocks install ldoc ``` 2. 在 Lua 代码中添加注释。注释的格式和标记可以参考前面的示例。 3. 运行 LDoc 工具。在终端中进入包含 Lua 代码的目录，然后运行以下命令： ``` ldoc . ``` 这将会在当前目录下生成一个名为 `doc` 的文件夹，其中包含生成的文档。 4. 打开生成的文档。在浏览器中打开 `doc/index.html` 文件，即可查看生成的文档。 LDoc 工具支持多种标记和配置选项，可以根据需要进行自定义。除了 LDoc，还有其他一些类似的工具，例如 LuaDoc、ldoc-markdown 等等，它们的使用方法和原理都类似。选择合适的工具可以帮助我们更加方便地生成和维护 Lua 代码的文档。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值