Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
DFVSQY opened this issue Sep 4, 2019 · 2 comments

Comments

@DFVSQY
Copy link

DFVSQY commented Sep 4, 2019

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

function Sum(a, b)
    local sum = a + b
    return sum
end
@DFVSQY DFVSQY changed the title 对于自定义的Lua函数,如何编写其注释才可以让鼠标悬浮到函数上时提示注释文档? 对于自定义的Lua函数,如何编写其注释才可以触发文档提示? Sep 4, 2019
@liwangqian
Copy link
Owner

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

@DFVSQY
Copy link
Author

DFVSQY commented Sep 5, 2019

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants