EmmyLua / VSCode-EmmyLua

Lua IDE/Debugger Plugin for VSCode
633 stars 89 forks source link

别名多行注释建议。 #82

Closed scc172fly closed 3 years ago

scc172fly commented 3 years ago

关于别名多行注释的问题,已经有人在几年前有人提出来,项目过程当中多行注释确实需要,现在的别名太长不太方便,而且不好写注释,无赖能力有限,不能提交PR,所以把我的构思说出来,等待大神提交PR。

推荐写法如下:

---@alias A @ 我是A,最重要的是能表示好结构体,结构体字段多,写一行实在无法看,还没的注释。 ---@filed a number @ 数字。 ---@field b ClassB @ 类对象。 ---@field f fun(arg: number, arg2: string):number @ 函数。 ---@endalias @ 以 endalias 结束,表示别名结束。

或者:

---@alias A @ 我是A,最重要的是能表示好结构体,结构体字段多,写一行实在无法看,还没的注释。 ---@filed a:number @ 数字。 ---@type b: ClassB @ 类对象。 ---@field f: fun(arg: number, arg2: string):number @ 函数。 ---@endalias @ 以 endalias 结束,表示别名结束。

坐等大神实现。