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