LuaLS / LuaLS/lua-language-server
为函数的参数增加key注释
Open
Nobody has claimed this yet.
question
- Dominant language
- Lua
- Stars
- 4.4k
- Forks
- 442
- PR merge metrics
- No merged PRs in 30d
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the request in the Visual Studio Code Extension with a Lua function whose table parameter has documented keys. Review LuaLS's existing parameter and @alias annotation behavior, then define how key annotations should be represented and displayed; done means the keys are clearly identifiable in the editor.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100