Was genau ist JSDoc ?

Bei JSDoc handelt es sich im Kern um ein reines Dokumentationsformat für JavaScript.
Das bedeutet, nur in Kombination mit dem TypeScript-Typechecker steht die Funktionalität der Typüberprüfung zur Verfügung.

Nun stellt sich dem Einen oder Anderen die Frage, warum man denn nicht direkt TypeScript verwenden sollte, wenn man doch sowieso nur typsicher mit dem TypeScript-Typechecker arbeiten kann und die Frage ist durchaus angebracht, aber leicht zu beantworten. TypeScript ist komplex, erfordert einiges an Übung im Umgang und der Anwendung und ist äußerst strikt. Diese Striktheit macht für enorm umfangreiche Enterpriseanwendungen durchaus Sinn, hat jedoch ihre Schattenseiten ! Ganze Foren und Social Media Threads sind voll mit Entwicklern, die TypeScript selbst als "unintuitiv" oder gar als "abstoßend" beschreiben und ihre Ansichten mit allerlei Beispielen untermauern. Diese Kritik ist absolut berechtigt und kommt keinesfalls von ungefähr.

Genau für diese Entwickler bietet die Kombination aus JSDoc zur Beschreibung des darunter befindlichen JavaScript-Codes und der Verwendung des TypeScript-Typechecker durch die Angabe von //@ts-check am Anfang der entsprechenden Datei einen Sweetspot zwischen Sicherheit und Einfachheit.
Es gilt jedoch zu beachten, das es sich weiterhin um reguläres JavaScript handelt und im Gegensatz zur Verwendung von TypeScript es keinen expliziten Compiler gibt der bei einem Typfehler die Ausführung des Codes verhindert !