LuaLS / LuaLS/lua-language-server

[Annotations] How to set a default value for a function parameter?

未关闭
#2,349 3 条评论 5 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

enhancement feat/LuaCats Annotations feat/type check
主要语言
Lua
星标
4.4k
派生
442
PR 合并指标
30 天内没有已合并 PR

描述

---@param name string
---@param age? number
function addPerson(name, age)
    age = age or 18
end

How can I specify that the age parameter is optional and has a default value of 18?
So that in the popup-menu it looks something like this:

function addPerson(name: string [,age = 18: number])

Or

function addPerson(name: string, age = 18: number)

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先跟踪 @param 注释的解析方式,以及函数签名在弹出菜单中的呈现方式。使用 addPerson 示例调查可选参数是否能够表示默认值 18,并在该默认值显示在所呈现的签名中时,视为工作完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
lua
领域
tooling
Issue 类型
功能
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
42/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。