Typescript to JSDoc

[shinokada]

Summary

Please watch this video.
Svelte 3 is in Typescripts and Svelte 4 will be in JSDoc.

Motivation

• Language agnostic: JSDoc is simply a way of writing documentation and type annotations in JavaScript-like languages, making it more versatile. You can use it in various contexts where TypeScript might not be as suitable. I have to edit my code on REPL.

• Easy integration: Since JSDoc is just a comment-based system, you don’t need to change your code or tooling. You can start adding JSDoc comments to your existing JavaScript codebase without much hassle.

• Lower learning curve: JSDoc is pretty straightforward and easier to learn compared to TypeScript, which might require developers to learn new syntax and type concepts.

• Documentation benefits: JSDoc offers a consistent way to write documentation for your code. This makes it easier for other developers to understand your codebase and helps in generating documentation pages.

• Gradual adoption: You can add JSDoc incrementally to your codebase, allowing you to gradually introduce type checking and documentation to your project without having to fully commit to TypeScript.

• No build step required: JSDoc doesn’t require a build step like TypeScript does for type checking and transpiring. This might be an advantage if you prefer a simpler development process.

Please note that TypeScript has its own advantages, such as more robust type checking, better IDE support, and more advanced features.

If we change to JSDoc, we need to consider how to generate props.json and change the their presentation.