How to specify default value from annotation?

[lua-rocks]

When I create a table and manually write field values, those values are visible in the class description. But I don't understand how to set them through annotations:

In this example I want to set foo = "bar":

---@class Test
---@field foo string = "bar"
local test = {
  hello = "world"
}

---

The same question I would like to ask about function parameters.

Currently I use such notation for default values:

---@param name string|nil `"_"`
---@param dumped table|nil `{}`
---@return string
function dump(name, dumped) end

But it doesn't look as good as the hello: string = "world" at the screenshot above.

[C3pa]

What about making a union type using |? It's not the same but may suit your needs.

---@class Test
---@field foo string|"bar"
local test = {
  hello = "world"
}

[lua-rocks]

What about making a union type using |? It's not the same but may suit your needs.

---@class Test
---@field foo string|"bar"
local test = {
  hello = "world"
}

I like this idea, but unfortunately tooltips lists types in uncontrolled order and when there are many of them it's hard to know which one will be used by default.

[C3pa]

Yeah, unfortunately, the annotations don't provide a way to mark a value as the default. In my annotations, I always start the description with Default: "somevalue" if the argument has it.