EmmyLua常用注解

EmmyLua是一款专用于Lua的编辑器插件,支持 Jetbrains 产品家族以及VSCode。EmmyLua插件利用注解 annotation 功能来增加代码提示以及其它编辑器功能。EmmyLua注解功能只是单纯的辅助编辑器代码提示以及其它功能,和Lua代码的实际运行逻辑没有任何关系,因为它们就是普通的Lua注释。

@class类声明注解

@type类型标记注解

标记类型

利用 @type 注解来标记目标变量的类型,以增强代码提示以及其它功能

标记为数组类型

标记为字典类型

标记为函数类型

标记为枚举类型

@alias 别名注解

可以使用 @alias 将一些复杂不容易输入的类型注册为一个新的别名

@param参数类型标记注解

@return 函数返回值注解

利用 @return 注解来标记函数的返回值类型

@field 属性注解

利用 @field 注解来标记某个类的额外的属性(即使这个属性没有出现在代码里)

@private、@public、@protected 权限注解

利用@private、@public、@protected 权限注解

@generic 泛型注解

利用 @generic 注解来模拟高级语言中的 泛型

1--@generic T1 [: PARENT_TYPE] [, T2 [: PARENT_TYPE]]

@vararg 不定参数注解

使用 @vararg 注解一个函数的不定参数部分的类型

@language内嵌语言

@see 引用