LuaCoderAssist icon indicating copy to clipboard operation
LuaCoderAssist copied to clipboard

对于自定义的Lua函数,如何编写其注释才可以触发文档提示?

Open DFVSQY opened this issue 6 years ago • 2 comments

给定一段Lua函数代码,什么样的注释格式才可以在使用该函数时触发注释文档提示? 例如以下的求和函数:

function Sum(a, b)
    local sum = a + b
    return sum
end

DFVSQY avatar Sep 04 '19 03:09 DFVSQY

暂时还不支持提示注释哈。后续再看是不是加上去

liwangqian avatar Sep 04 '19 15:09 liwangqian

@liwangqian 能根据函数的签名自动生成注释内容是一个很方便的注释方式,希望尽可能加上这个功能,类似插件“Lua Analyzer”具有这样的功能,作者可以参考下。

DFVSQY avatar Sep 05 '19 07:09 DFVSQY