LuaLS / LuaLS/lua-language-server
为函数的参数增加key注释
未关闭
还没有人认领这个 Issue。
question
- 主要语言
- 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?
Other
Expected Behaviour
当一个函数的参数为table时,该怎么为这个参数内的一些key做说明呢,
比如这个例子,直接这样写注释是可以看到,但是看起来乱糟糟的,无法清楚的识别,
有什么办法可以做到类似@alias的格式很方便观看table内每个key都是需要传入什么吗
Actual Behaviour
如上
Reproduction steps
- Go to '...'
- Click '...'
- See error '...'
Additional Notes
No response
Log File
No response
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
使用一个具有文档化键的 Lua 表参数函数,在 Visual Studio Code Extension 中重现该请求。检查 LuaLS 现有的参数和 @alias 注解行为,然后定义键注解应如何表示和显示;完成意味着这些键在编辑器中能够被清晰识别。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- lua
- 领域
- devtools
- Issue 类型
- 功能
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 20/100