LuaLS / LuaLS/lua-language-server

@see annotaton duplicates documentation when using with @class

未關閉
#2,570 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 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.
![image](https://github.com/LuaLS/lua-language-server/assets/75124358/6ab99d16-3b1c-420d-80ef-5b4ce43f8a85)

### Reproduction steps

Here is basic code sample. Hovering or typing `class1` causes issue with displayed documentation
```lua
--- some class dock
---
---@class C2
local class2 = {}

--- another class dock here
---
---@see C2
---@class C1
local class1 = {}

---@type C1
local class1_instance = class1
```

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

從 issue 中提供的 Lua 重現開始,比較 C1 在有和沒有 @see C2 註解時的 hover 結果。由於沒有指定 repository 檔案或測試,因此請定位 language server 使用的註解與類別文件處理邏輯,然後驗證 C1 的文件只顯示一次,同時 @see 參照仍然可用。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
lua
領域
devtools
Issue 類型
缺陷
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
48/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。