LuaLS / LuaLS/lua-language-server
`@param` fails to include multiline description
Dieses Issue hat noch niemand übernommen.
- 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 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
---@param foo integer
---
---Long description with multiple paragraphs, and a code example:
---
---Usage:
---```lua
---local result = x(5)
---```
function x(foo) end
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Reproduziere das Verhalten in der VSCode-Erweiterung mithilfe der Lua-Snippets im Bericht und verfolge anschließend den Pfad der Annotation-Verarbeitung für mehrzeilige @param-Beschreibungen. Als erledigt gilt die Aufgabe, wenn umgebrochener Text, Absatzumbrüche und das gezeigte Codebeispiel korrekt erhalten bleiben. Im Bericht wird keine Quelldatei und kein Test genannt, daher gehört es zur Aufgabe, den Parser und die vorhandenen Annotation-Tests zu finden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- lua, vscode
- Bereich
- devtools
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100