LuaLS / LuaLS/lua-language-server

为函数的参数增加key注释

Aperta
#2,216 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

question
Lingua principale
Lua
Stelle
4.4k
Fork
442
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Riproduci la richiesta nella Visual Studio Code Extension con una funzione Lua il cui parametro di tipo tabella abbia chiavi documentate. Esamina il comportamento esistente di LuaLS per i parametri e le annotazioni @alias, quindi definisci come devono essere rappresentate e visualizzate le annotazioni delle chiavi; il lavoro è completato quando le chiavi sono chiaramente identificabili nell’editor.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
lua
Ambito
devtools
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
20/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.