LuaLS / LuaLS/lua-language-server
Alias comments only show for strings and numbers
未關閉
還沒有人認領這個 Issue。
- 主要語言
- Lua
- 星號
- 4.4k
- 分支
- 442
- PR 合併指標
- 30 天內沒有已合併 PR
描述
(Split from: https://github.com/LuaLS/lua-language-server/issues/2279)
Aliases have a feature where they can be multiline and you can write comments for different available values. However, this only works for string and numbers. For example in this code:
---@class TestClass
---@enum TestEnum
TestEnum = {
TEST1 = 1,
TEST2 = 2,
TEST3 = 3,
}
---@alias TestAlias
---| 'TEST1' # TEST1 comment
---| 'TEST2' # TEST2 comment
---| 'TEST3' # TEST3 comment
---| TestClass # TestClass comment
---| TestEnum # TestEnum comment
---| TestEnum.TEST1 # TestEnum.TEST1 comment
---| 1 # TestNumber Comment
---@param test TestAlias
local function test(test)
end
test()
I get this
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
使用 issue 中的 alias 範例在 LuaLS 中重現該報告,然後追蹤 string 值和數值的 alias 註解如何被收集及顯示。對 TestClass、TestEnum 和 TestEnum.TEST1 檢查相同的行為;當這些 alias 值的註解如同 string 和數字的註解一樣顯示時,即表示完成。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- lua
- 領域
- devtools
- Issue 類型
- 缺陷
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100