LuaLS / LuaLS/lua-language-server

It is better to have multiline for annote the @overload

未关闭
#2,323 14 条评论 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
--- @overload fun(
--- x:number,
--- y:number,
--- width:number,
--- height:number
--- ):Object
Actual Behaviour
--- @overload fun(  x:number, y:number, width:number, height:number  ):Object
Reproduction steps
  1. Go to '...'
  2. Click '...'
  3. See error '...'
Additional Notes

Please adding this feature because some of my annotation is really really long.

Writing in one line makes unreadable and ugly.

Thanks much!

Log File

No response

贡献指南

打开贡献指南

从这里开始

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

调研方向

使用 issue 中的多行和单行 @overload 示例,复现 Visual Studio Code 扩展中的注解行为。首先跟踪 Lua 注解的解析方式,然后验证多行 overload 签名能够被接受并保持可读性,同时不会破坏现有注解。

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

评估

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

把新 issue 发到你的邮箱

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