LuaLS / LuaLS/lua-language-server

@return支持多种类型

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

還沒有人認領這個 Issue。

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

描述

两个方案,大佬参考:
方案一采用语法@return ()|()|()这种

---@return (string,number)|(nil, string)
local function foo()
  do
    return 'foo', 1 --正常
  end
  do
    return nil, 'some error' --正常
  end
  do
    return nil, 1 -- 此处出错
  end
end

方案二,其实我觉得这种更直观,也便于书写

---@return string,number
---@return nil, string
local function foo()
  do
    return 'foo', 1 --正常
  end
  do
    return nil, 'some error' --正常
  end
  do
    return nil, 1 -- 此处出错
  end
end

现在的设定,下面两种定义是等效的

---@return string,number
local function foo() end

---@return string
---@return number
local function foo() end

可见,通过逗号表达式,一条@return语句就可以表达多个值类型,多条连续的@return语法应该留给更重要的多返回类型语法!优雅,简洁!个人愚见,仅供参考

貢獻指南

開啟貢獻指南

從這裡開始

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

研究方向

先檢查 language server 現有的 @return 解析與回傳型別驗證,然後將兩種提議的語法與 issue 中的範例進行比較。完成的條件是:一種達成共識的語法支援多個替代回傳簽名,並拒絕範例中所示的不相符回傳值,同時涵蓋現有的逗號分隔行為。

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

評估

技術堆疊
lua
領域
tooling
Issue 類型
功能
難度
5/5
預估耗時
一週以上
活躍度
停滯
描述清晰度
基本清楚
新手友好度
35/100

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

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