How to annotate table that uses indexing and not field names.

[vnaoScriptHub]

New LuaLS user here.

One example of an API return table that I'm trying to annotate as a class.

VersionInfo = {
   ["FileVersion"] = {
	[1] = 2,
	[2] = 9,
	[3] = 7,
	[4] = 59074,
   },
}

As you can see below, not sure how to annotate this.

---@class VersionInfo
VersionInfo  = {
    ---@class FileVersion
    ---@field ??? integer Major version.
    ---@field ??? integer Minor version.
    ---@field ??? integer Revision number.
    ---@field ??? integer Build number.
    FileVersion = {}
}

[tomlau10]

use the [index] syntax

---@class VersionInfo
VersionInfo  = {
    ---@class FileVersion
    ---@field [1] integer Major version.
    ---@field [2] integer Minor version.
    ---@field [3] integer Revision number.
    ---@field [4] integer Build number.
    FileVersion = {}
}

local a = VersionInfo.FileVersion[1]    --< integer
local b = VersionInfo.FileVersion[5]    --< unknown

[vnaoScriptHub]

Thank you!

[vnaoScriptHub]

So that works but for some reason the comments don't show up.

[tomlau10]

As far as I know, fields comments are shown only when you index the field

---@class VersionInfo
VersionInfo  = {
    ---@class FileVersion
    ---@field [1] integer Major version.
    ---@field [2] integer Minor version.
    ---@field [3] integer Revision number.
    ---@field [4] integer Build number.
    FileVersion = {}
}

local a = VersionInfo.FileVersion.<trigger auto complete here>

I don't know if there is a way to show the fields comments in the class hover preview 🤔

[tomlau10]

Maybe you can add docs for the FileVersion itself, luals supports markdown when writing documents.
But I think this breaks the the idea of writing field documents in the beginning...

---@class VersionInfo
VersionInfo  = {
    ---File version details
    --- - `[1]`: Major
    --- - `[2]`: Minor
    --- - `[3]`: Revision
    --- - `[4]`: Build
    ---@class FileVersion
    ---@field [1] integer Major version.
    ---@field [2] integer Minor version.
    ---@field [3] integer Revision number.
    ---@field [4] integer Build number.
    FileVersion = {}
}

local a = VersionInfo.<trigger completion>

---

If showing the fields comments in the class hover preview has not be implemented, I think it can be feature requested. Though I don't know when will it get actually implemented 😂 given so many open issues currently in the repo.

[vnaoScriptHub]

Adding docs will work. Thank you.