LuaLS / LuaLS/lua-language-server
@see annotaton duplicates documentation when using with @class
未关闭
还没有人认领这个 Issue。
- 主要语言
- Lua
- 星标
- 4.4k
- 派生
- 442
- PR 合并指标
- 30 天内没有已合并 PR
描述
How are you using the lua-language-server?
Visual Studio Code Extension (sumneko.lua)
Which OS are you using?
Windows
What is the issue affecting?
Annotations
Expected Behaviour
I'm trying to add some @see tags to my @class
Actual Behaviour
When hovering class in editor, displayed documentation is printed twice.
Reproduction steps
Here is basic code sample. Hovering or typing class1 causes issue with displayed documentation
--- some class dock
---
---@class C2
local class2 = {}
--- another class dock here
---
---@see C2
---@class C1
local class1 = {}
---@type C1
local class1_instance = class1
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 issue 中提供的 Lua 复现开始,比较 C1 在有和没有 @see C2 注解时的 hover 结果。由于没有指定 repository 文件或测试,因此请定位 language server 使用的注解和类文档处理逻辑,然后验证 C1 的文档只显示一次,同时 @see 引用仍然可用。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- lua
- 领域
- devtools
- Issue 类型
- 缺陷
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 48/100