LuaLS / LuaLS/lua-language-server

为函数的参数增加key注释

Offen
#2,216 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

question
Vorherrschende Sprache
Lua
Sterne
4.4k
Forks
442
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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做说明呢,
image
比如这个例子,直接这样写注释是可以看到,但是看起来乱糟糟的,无法清楚的识别,
有什么办法可以做到类似@alias的格式很方便观看table内每个key都是需要传入什么吗

Actual Behaviour

如上

Reproduction steps
  1. Go to '...'
  2. Click '...'
  3. See error '...'
Additional Notes

No response

Log File

No response

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Reproduziere die Anfrage in der Visual Studio Code Extension mit einer Lua-Funktion, deren Tabellenparameter dokumentierte Schlüssel besitzt. Überprüfe das bestehende Verhalten von LuaLS bei Parameter- und @alias-Annotationen und lege anschließend fest, wie Schlüsselannotationen dargestellt und angezeigt werden sollen; als erledigt gilt die Aufgabe, wenn die Schlüssel im Editor eindeutig erkennbar sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
lua
Bereich
devtools
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
20/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.