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

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

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、使用LuaDoc

在需要生产文档的目录，如scripts\app\data中，shift加右键，选择在此处打开命令行

在cmd中输入: 

最低0.47元/天 解锁文章

新学期VIP享超值加赠
暮雨天澜
关注
Java项目适用的的AI注释生成工具（边实践边记录）
从技术实践立足，从项目管理方法论延伸思考
06-05 1532
本文介绍了几种适用于Java项目的AI注释生成工具，包括IDE插件（如JAutoDoc、通义灵码）、独立工具（如FittenCode、CodeGeeX）和云服务（如腾讯云AI代码助手、GitHub Copilot）。这些工具能自动生成符合Javadoc规范的注释，减少手动输入。建议根据开发环境和项目需求选择合适工具，如Eclipse用JAutoDoc，IntelliJ用通义灵码。虽然AI工具能提高效率，但对于复杂业务逻辑仍需人工审核，建议结合团队规范使用。不同工具在支持语言、生成精度和费用上有所差异，需按实
快速生成某个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语言的超级详细基础教程
编程捍卫者的博客
09-15 993
C++ #c 易语言等等载具 的编程平台都可以使用，也是最快捷最简单，最方便的一门脚本语言
自动生成查找组件的lua代码
Jeremy201500的博客
05-20 436
　　本篇主要解决的问题是使用lua脚本编写unity业务逻辑时，自动生成一些查找组件及绑定控件事件的lua代码！ 　　现在很多unity项目都是用ulua作为热更新解决方案，因此需要用lua来写相关的逻辑，经常会用到的就是在lua中查找某个对象，尤其是写一些UI逻辑！ 　　比如在Login界面中有登陆按钮、记住密码勾选框，在lua中获取这两个按钮可能的lua代码写法就是： a1 s...
Windows下使用luaDoc给lua生成文档
weixin_34380296的博客
10-09 348
首先需要安装lua，Windows下自然是安装Lua For Windows咯，下载地址:http://code.google.com/p/luaforwindows/安装以后它已经包含了luadoc，所以无需我们再去下载，如果非要去下载的话，那么下载地址是：http://luadoc.luaforge.net/。然后，我们需要准备一个批处理文件，叫啥...
LDoc文档生成器：LuaDoc兼容性及C扩展源处理
LDoc的主要功能是自动生成代码库的文档，它通过读取源代码文件中的注释和标记信息来创建文档。这些文档通常包含模块的描述、函数列表、每个函数的参数和返回值、示例代码以及其他相关的开发信息。文档生成过程可以是...
Loco:用于Lua源代码的内联文档生成器-lua source code
03-25
它旨在帮助开发者通过注释在源代码中嵌入文档，从而自动生成易于理解和维护的API文档。这一工具的出现，使得Lua项目的文档编写变得更加便捷，同时也有助于提高代码的可读性和团队间的协作效率。 **一、内联文档的...
lua 代码注释工具
最新发布
05-17
3. LuaDoc-like：LuaDoc-like是一种轻量级的Lua代码注释工具，它不需要使用特定的标记语言，而是通过一些简单的规则来解析注释，并生成文档。 以上是我了解到的常见的Lua代码注释工具，您可以根据自己的需求选择...
Lua文件API生成工具的快速开发指南
在Lua中，可以使用像`LDoc`或`luadoc`这类工具来生成API文档。这些工具扫描Lua源代码，并根据代码中的注释生成文档。 在Lua源代码中，注释通常遵循一定的格式，例如： ```lua --- 这是一个单行注释示例 -- 这是另...
利用Ldoc生成lua的doc文档
yeputi_WK的博客
09-28 1193
转处 【原文链接】 如果下面操作出现无法执行lua代码的，需要先安装lua。详见下文第四点。 一、安装LuaRocks 1.1、下载luarocks 下载地址为：http://luarocks.org/releases/luarocks-2.2.1.tar.gz 或者http://luarocks.org/releases/ 1.2、解压到本地磁盘 1.3、...
luaDoc 试用心得
~。~|||
09-16 2156
--- 继承于某table的属性及函数 -- @param selfclass 某table -- @param parentclass 需要继承的table -- @return 继承后的类 -- @usage local _widgetnotebox = _Inherit( {}, WIDGET_BASE )
C#窗体应用程序实现cocos2dx json文件自动生成lua文件
aschen518的博客
12-10 929
文件解析部分： using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Windows.Forms; using System.IO; namespace WindowsFormsApplication3 {     class G
不用写注解就可以生成文档的工具，你晓得不？
程序员麦冬的博客（公众号同名）
08-21 435
今天给大家安利一款接口文档生成器——JApiDocs。不用写注解，就可以生成文档的工具，你心动了吗？ 下面我们一起来看看如何使用！ 一、添加依赖 <dependency> <groupId>io.github.yedaxia</groupId> <artifactId>japidocs</artifactId> <version>1.3</version> </dependency> 二、配置生成参
Lua 读表代码，自动生成字段名字
weixin_30598225的博客
07-25 176
表格格式为 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 1547
标签 @module 模块, 一般一个文件就是一个模块. @classmod 和 @module 类似, 但是用来描述 class, 用这个标签后, 生成的文档中 Module 文字会变成 Class. @submodule 如果一个模块的内容被分到了好几个文件中, 那么就可以再其他文件中用 submodule 来定义, 后面跟上master module的名字. @script 和 @modu...
Lua Doc生成工具
weixin_33798152的博客
11-10 438
Luadoc http://keplerproject.github.io/luadoc/ Overview LuaDoc is a documentation generator tool for Lua source code. It parses the declarations and documentation comments in a set of Lua source f...
cocos2dx-lua绑定之代码编辑器
热门推荐
wtyqm的专栏
07-16 1万+
享受脚本语言灵活、更新方便、免于编译的好处，但也不能忍受离开那些方便的IDE特性（跳转、自动完成）。 搜集整理了一些使用Sublime Text编辑cocos2dx-lua工程的资料，希望能给大家带来帮助。
Lua 自动属性实现
Hustlion 的技术博客
07-09 1693
Lua 自动属性实现 在 MMORPG 游戏中，玩家具有非常多的属性，有多数情况下这些属性都是从服务器获取然后不需要经过运算即可展示。 在项目规范较好的情况下，不会直接取用存储的数值而是使用 getter, setter。但是这些没有额外逻辑的 getter setter 写起来很麻烦。 所以笔者利用 lua 灵活的机制实现了一个简单的自动属性特性。 具体如下。 实现 使用时将要自动生成的属性传给...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值