"EmmyLua Annotations" article on Wiki

[serg3295]

First of all, I would like to thank @Ketho for an excellent article.

I propose to discuss in this thread additions to the article, as well as the use of EmmyLua tags in the @sumneko extension.

Here are some my suggestion:

Section @return

--- with return name
---@return string newmsg comment
function Foo1(msg) end

--- without return name
---@return string # newmsg comment
function Foo2(msg) end

Section @comments

Annotation comments start with @ or #

In line ---@param symbol "@" or "#" can be omitted

--- ordered and unordered list:
---@param tbl table comments for param *tbl*
-- - *unordered list*
--   - item Level 2
--     - item level 3
--* *ordered list*
-- 1. item 1
-- 8. item 2
function Greet(tbl) end

Section @deprecated

[Ketho]

Wow I didn't know @ or # for comments could be omitted for @param and @return. The markdown and @deprecated example looks good to me as well 😊

[serg3295]

# or @ could be omitted for @return only if 'return_ name' is present, otherwise the word following "return type" will be treat as "return_name"

[serg3295]

Here is information about the @meta tag. See #370

[serg3295]

in the article:
disable - Disables diagnostics for the file.
enable - Enables diagnostics for the file.

It seems to me -- enable / disable acts as trigger.

[serg3295]

Has anyone figured out how the @see tag works?
any example, please.

[Ketho]

I'm not sure if it even does anything. It appears to be used like a normal comment annotation.

[serg3295]

---In the function description, there is an additional possibility of breaking line\
---using the backslash character at the end of the string.\
---In addition, in the lines `@param` and `@return`, you can use construction\
---"line1  \nline2  \n lineI" to break the line. Note the two spaces preceding `\n`
---@param name string "This is a very, very long string that needs to be split  \n into several lines,  \nsay three lines."
---@return boolean  "returns `true` if OK,  \nOtherwise returns `false`."
function foo(name) end