microsoft / microsoft/TypeScript

Support auto-completion for TSDoc

Offen
#61,592 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Awaiting More Feedback Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
2 T. 4 Std.
Gemergte PRs (30 T.)
132

Beschreibung

🔍 Search Terms

tsdoc complete

✅ Viability Checklist
⭐ Suggestion

TypeScript currently only supports auto-completion for JSDoc, not TSDoc. For example, there is no intelligent suggestion for @defaultValue.

Image

📃 Motivating Example

If TSDoc is the recommended commenting standard for TypeScript, then it should natively support intelligent suggestions and syntax highlighting for TSDoc.

💻 Use Cases

Writing comments using TSDoc syntax in VSCode.

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

Beginne damit zu untersuchen, wie TypeScript derzeit die automatische Vervollständigung für JSDoc bereitstellt und wie VSCode diese Ergebnisse des Language Service verarbeitet. Vergleiche dieses Verhalten mit TSDoc-Tags wie @defaultValue und bestimme das erwartete Verhalten für Syntaxhervorhebung und Vervollständigung; abgeschlossen ist die Aufgabe, wenn TSDoc-Kommentare intelligente Vorschläge erhalten, ohne das erzeugte JavaScript zu verändern.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
developer-experience, tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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