使用lua开发,必不可少的插件就是 EmmyLua,通过EmmyLua,我们可以实现代码跳转、代码提示、语法检查等功能。本文将介绍如何在Lua项目中配置和使用EmmyLua插件,以提升开发效率。
Lua 注释与类型标注规范(基于 EmmyLua)
快速自检清单(迷你版)
本规范覆盖从文件头、模块导出、表/类结构、函数与重载、枚举、事件、异步与协程、xLua 互操作,到落地实践与检查清单的完整做法;提供可直接复制的模板与范例。
目标与原则
- 可读性优先:注释写「做什么、为何这样做」,代码体现「如何做」。
- 面向工具:严格遵循 EmmyLua 语法,确保跳转、补全、诊断与重构可用。
- 渐进式标注:优先覆盖模块导出、公共 API、复杂表结构与跨语言边界。
- 工程友好:与 xLua、Unity 工程、事件与协程模型自然兼容。
1. 基本注释风格