TS ist schlecht im Hovertext

Ein wörtlicher Engel (AngelCMHxD) hat eine PR gegen eines meiner Repos durchgeführt, um eine .d.ts-Definitionsdatei sowohl für die automatische Vervollständigung als auch für den Hover-Text hinzuzufügen. Folgendes geschah als nächstes...

---

Nachdem er seine PR lokal mit der TypeScript .d.ts-Datei getestet hatte, war das Ergebnis folgendes:

Beachten Sie, dass ich den Mauszeiger über die Windows-Taste bewege und sie mir keine wertvollen Informationen liefert. Es liefert das gleiche abgeschnittene Textchaos (das visuell schwer zu analysieren ist), wie wenn Sie mit der Maus über „createDesktopShortcuts“ fahren.

---

Das Repo wurde bereits mit JSDocs geschrieben, die überall über ein einfaches Linting-Plugin durchgesetzt wurden (verwenden Sie es, es ist sehr gut). Im Vergleich dazu bietet JSDocs die gleiche Typunterstützung wie TS und weitaus bessere Hinweise.

---

Mit JSDocs erhalten wir einen saubereren Hover:

Und wenn wir den Mauszeiger über die Windows-Taste halten, erhalten wir einen viel besseren Kontext und erklären, dass dafür eine Dateipfadzeichenfolge erforderlich ist.

---

Letztendlich gab es keine Möglichkeit, TS dazu zu bringen, einen brauchbaren Hover-Tooltip zu generieren. Ihre offizielle Empfehlung ist die Verwendung von JSDocs.

Da die TypeScript-Engine und der Compiler mit in JSDocs definierten Typen genauso funktionieren wie mit Typen, die in der TypeScript-Syntax geschrieben sind, verwendet meine Bibliothek überhaupt kein TypeScript, sondern ist vollständig typisiert und vollständig TS-kompatibel.

Das obige ist der detaillierte Inhalt vonTS ist schlecht im Hovertext. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!