LuaLS / LuaLS/lua-language-server
`@param` fails to include multiline description
未关闭
还没有人认领这个 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 WSL
What is the issue affecting?
Annotations
Expected Behaviour
Attributes should be correctly parsed when they wrap over multiple lines.
Actual Behaviour
In VSCode:
---@param foo integer This is a long description that wrongs over multiple lines
---but is misinterpreted.
function x(foo) end
---@param foo integer
---
---Long description with multiple paragraphs, and a code example:
---
---Usage:
---```lua
---local result = x(5)
---```
function x(foo) end
Reproduction steps
Paste code above into VSCode.
Additional Notes
Surely it should be possible to write more than a single line of description for a parameter (and other tags).
Log File
No response
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
使用报告中的 Lua 代码片段复现 VSCode 扩展中的行为,然后跟踪多行 @param 描述的注解解析路径。当换行文本、段落分隔以及显示的代码示例都能正确保留时,即视为完成。报告没有指出源文件或测试,因此定位解析器和现有的注解测试也是工作的一部分。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- lua, vscode
- 领域
- devtools
- Issue 类型
- 缺陷
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100