在lua脚本工程里给C++函数添加智能文档提示

决定吃小菜

工具环境准备：

• 安装VS Code，点击打开官方网址
• 给VS Code安装EmmyLua扩展最新版(>0.9.23)
  

创建lua库文件，即智能提示文档文件：

1.lua工程目录之外随便找一个目录当作库目录，我是放在了c++工程目录下的doc目录里，那里本身也有一些c++api的一些说明

2.在库目录里新建一个.lua文件，名字随便起。

3.在此lua文件里编辑c++api同名变量和函数的文档，我在附件里提供了一份示例，大部分应该是通用的，可根据自己使用的c++端稍微调整。
c_api.zip (5.76 KB, 下载次数: 0)

2025-6-30 10:04 上传

点击文件名下载附件

配置lua库目录：


1.使用VS Code打开lua工程

2.打开.emmyrc.json文件，没有就手动创建，然后记得加入git忽略列表里（看到文件红名了吗，血的教训啊）



3.在workspace字段下library数组里加上库目录路径，保存即可生效

1. {
   
2.     "workspace": {
   
3.             "library": ["d:/jysdl/doc"],
   
4.             "encoding": "utf-8",
   
5.             "reindexDuration": 3000
   
6.     }
   
7. }

复制代码

效果展示：


鼠标放在函数名上时会有浮窗提示函数文档，写入参数时也会提示对应位置的参数应该是什么。


对于我这种记性不好的人来说，可算从来回翻lua工程与c++工程的麻烦中解脱了！






最后：


EmmyLua还提供了非常多实用的功能，例如断点调试、函数跳转、代码检测等。


除了添加库目录也有非常丰富的可配置项，具体参考扩展主页提供的文档。


就是想分享一个编码小技巧，希望能帮到大家。