LuaLS / LuaLS/lua-language-server
为函数的参数增加key注释
オープン
まだ誰も着手していません。
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 にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
テーブルパラメーターにドキュメント化されたキーを持つ Lua 関数を使用して、Visual Studio Code Extension でリクエストを再現します。LuaLS における既存のパラメーターおよび @alias アノテーションの動作を確認し、キーアノテーションをどのように表現して表示するかを定義します。完了条件は、エディター内でキーを明確に識別できることです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- lua
- 領域
- devtools
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 20/100