microsoft / microsoft/TypeScript

Formatting Intellisense For Better JS/TS Doc Integration

Aperta
#60,300 1 commento 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Experience Enhancement Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.4k
Merge medio
1g 19h
PR unite (30g)
117

Descrizione

Does anyone know if it is possible to modify VSCode Intellisense for JSDoc and TSDoc tags? I have always been bothered by the way VSCode handles certain JS/TS doc tags and I just cannot handle it anymore.

As trivial as it might sound, when documenting custom interface and type definitions, I just want the @property tag to be formatted in the same manner as the @param tag. The following screen shots illustrate my issue:

Image

Notice the emdash between the @property tags and the keys being described above?

Image

See how it's placed after the @param tags and the respective keys?

If this feature cannot be implemented, does anyone know of any extensions that already do this or which files need to be modified to make this change?

Any advice would be much appreciated. Cheers 🍻

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

Non è identificato alcun file sorgente o test. Inizia tracciando il modo in cui VSCode e TypeScript IntelliSense formattano i tag @property e @param di JSDoc e TSDoc, quindi determina se la modifica appartiene a TypeScript o a un'estensione. Il lavoro è completato quando i tag pertinenti vengono visualizzati con una formattazione coerente delle chiavi, supportata da un test appropriato o da una limitazione documentata dell'estensione.

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

Valutazione

Stack tecnologico
javascript, typescript, vscode
Ambito
developer-experience, tooling
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.