LuaLS / LuaLS/lua-language-server

`@param` fails to include multiline description

オープン
#3,083 コメント 9 件 リアクション 2 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
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

Image

Image

---@param foo integer
---
---Long description with multiple paragraphs, and a code example:
---
---Usage:
---```lua
---local result = x(5)
---```
function x(foo) end

Image

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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

レポート内のLuaスニペットを使ってVSCode拡張機能の動作を再現し、次に複数行の@param説明に対するアノテーション解析の経路を追跡します。折り返されたテキスト、段落区切り、表示されているコード例が正しく保持されれば完了です。レポートにはソースファイルもテストも記載されていないため、パーサーと既存のアノテーションテストを見つけることも作業の一部です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
lua, vscode
領域
devtools
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。