LuaLS / LuaLS/lua-language-server

Add the ability to annotate exceptions @raises

未關閉
#1,610 3 則留言 5 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

enhancement feat/LuaCats Annotations
主要語言
Lua
星號
4.4k
分支
442
PR 合併指標
30 天內沒有已合併 PR

描述

Hello! I have a suggestion to add a new annotation - @raises
I think it would be useful to anyone who has a layer of error classes in their module.

**Example:**
```lua
--- @class NetworkError: cdata
--- @field code number
--- @field body number

--- @raises
---| NetworkError
function some_func() end
```

貢獻指南

開啟貢獻指南

從這裡開始

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

研究方向

此 issue 未指定檔案或測試。首先檢查現有註解的解析與驗證方式,然後確定 @raises 和 NetworkError 範例的預期行為。完成的標準是能夠辨識該註解,並以一致的方式處理其宣告的例外類型。

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

評估

技術堆疊
lua
領域
devtools
Issue 類型
功能
難度
5/5
預估耗時
一週以上
活躍度
停滯
描述清晰度
需要釐清
新手友好度
32/100

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

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