-
-
Notifications
You must be signed in to change notification settings - Fork 320
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
Quoted string in the comment #2013
Comments
Double quotes are used for inserting line breaks in the
See discussion |
So escaping the first double quote fixed it. I was confused because quoted string in the middle of the comment doesn't have to be treated specially: ---@param a any "lorem ipsum" this is ignored
---@param b any \"lorem ipsum" this is shown
---@param c any this "quoted string" is also shown
local function foo(a, b, c) end |
Unfortunately, this feature is not documented in the wiki. It is still "Under Review" 😄 |
Is someone able to summarize how newlines can be done, so I can add to the wiki? Last I remember hearing, there were drawbacks to each method (double space, backslash, |
All these methods are already implemented and work fine.
|
My go-to way to insert line breaks in annotation comments is to leave an empty line with just |
An empty line with |
Updated the wiki |
How are you using the lua-language-server?
Visual Studio Code Extension (sumneko.lua)
Which OS are you using?
Linux
What is the issue affecting?
Annotations
Expected Behaviour
Show full comments.
Actual Behaviour
Comment for the
@param
that starts with a quoted string ignores everything after the string.Reproduction steps
Additional Notes
No response
Log File
No response
The text was updated successfully, but these errors were encountered: