pc8888888 发表于 2023-1-9 14:15

【从零开始游戏开发】EmmyLua插件注解功能

你知道的越多,你不知道的越多      
点赞再看,养成习惯,别忘了一键三连哦   
文章持续更新中   
1前言   
网上配置 EmmyLua 的方法很多,此处就不做赘述(因此前提是你已经安装配置完EmmyLua)
本文仅是对 EmmyLua插件 内 注解功能 用法的代码演示。因为网上大部分EmmyLua配置教程中都没对此部分进行讲解,而实际lua开发时EmmyLua的注解功能几乎必不可缺,故作此文
2 注解的目的   
我们在编写C#脚本时,IDE的相关插件能提示各类方法或成员以及描述:


但Lua内,即便安装完EmmyLua,不写注解的话,也就没有任何提示(灰色提示仅表示刚有写过该参数而已,完全不知道是成员变量或方法):


3注解用法   

类的声明<br/>基本格式:--@class MY_TYPE[:PARENT_TYPE] [@comment]


类的额外属性
即使该类未持有某属性,也可以通过添加注解,在提示内出现(PS:其实EmmyLua实现UnityAPI的提示也是基于此的)
基本格式:---@field field_name FIELD_TYPE[|OTHER_TYPE] [@comment]


变量的类型<br/>基本格式:---@type MY_TYPE[|OTHER_TYPE] [@comment]
PS:按上述官方用法,comment描述应当放在末尾,但我这试了下type不大行,可以放在顶部


函数
标记函数定义参数的类型:---@param param_name MY_TYPE[|other_type] [@comment]
标记函数的返回值类型:---@return MY_TYPE[|OTHER_TYPE] [@comment]


备注
在IDEA下,对目标使用Alt+Enter快捷键(或点小灯泡),可较方便自动补全注解:


4完整示例   

现有Person基类,Gamer类继承自Person,在Main.lua内实现两个类的创建及使用(直接粘到本地跑就行):
Main.lua:


Person.lua:


Gamer.lua:


免费领取海量资源
简历自测评分表、Unity职级技能表、面试题库、入行学习路径等
点击下方卡片,获取游戏开发福利
    点击下方卡片,获取游戏开发福利
页: [1]
查看完整版本: 【从零开始游戏开发】EmmyLua插件注解功能