core VS JSDoc

Nuxt is an open-source framework for building performant websites and full-stack applications using Vue.js. It provides performance and SEO benefits, and adds full-stack capabilities for Vue apps.

As you can see, it's a simple Single Page Application built with Vue.js where our users can sign up / sign in with a few clicks.

Similarly to Promises/A+, this effort focuses on aligning the JavaScript ecosystem. If this alignment is successful, then a standard could emerge, based on that experience. Several framework authors are collaborating here on a common model which could back their reactivity core. The current draft is based on design input from the authors/maintainers of Angular, Bubble, Ember, FAST, MobX, Preact, Qwik, RxJS, Solid, Starbeam, Svelte, Vue, Wiz, and more…

Vue.js is an open source web framework that makes developing web applications easier.

Frameworks and Libraries: There are numerous JavaScript frameworks and libraries, such as React, Angular, and Vue.js, which simplify the development of complex web applications.

Javascript in the browser React - react is a library that gives developers an application programming interface (API) to manipulate the DOM (this is React's ReactDOM package). React uses components and JSX to make building reusable code easier. docs JSX - is a syntax extension for React Javascript code that lets you write HTML-like markup in a javascript file. This makes it easier to write reusable HTML. docs State - a key react concept that guides setting and storage of data between renders. docs Hooks - a key react concept for logic triggered by state change docs Vue - is a framework for building web interfaces. Vue is lightweight and best for small projects prioritizing speed over functionality. doc Angular - web development framework. Angular is best for dynamic more feature rich sites. docs

Vue

Vue 3 Reactivity Source Code

Nonetheless, it offers nearly infinite possibilities. You can code and create anything, from a mobile app with React Native to a desktop application with Electron.js. Furthermore, JavaScript provides excellent frameworks and libraries that can be applied in various approaches, such as React, Three, Vue, Meteor, and Astro.

From your own example, here is the text from https://vuejs.org/ as of today:

> The Progressive JavaScript Framework

> An approachable, performant and versatile framework for building web user interfaces.

> Approachable - Builds on top of standard HTML, CSS and JavaScript with intuitive API and world-class documentation.

> Performant - Truly reactive, compiler-optimized rendering system that rarely requires manual optimization.

> Versatile - A rich, incrementally adoptable ecosystem that scales between a library and a full-featured framework.

Yes, performance is mentioned. But it's hardly the main selling point, and they don't even mention DOM manipulation, they're talking about the rendering in general.

Lit isn't even a framework, it's a "web components library".

> all modern frameworks

Yeah, "all modern frameworks" being one framework + one library?

I wholeheartedly agree. At most, I introduce JSDoc[1] to newer developers as standardising how parameters and whatnot are commented at least gets you better documentation and _some_ safety without adding any TS knowledge overhead.

[1] https://jsdoc.app/

This is where JSDoc comes to save the day.

The best way to do this, of course, is with JSDoc. But something I always found awkward about jsdoc is defining the object types in the same file. So, after a lot of reading, I found a way to combine JSDoc with declaration type files from Typescript. Let me give you an example:

There is a lot of specific symbols presented on the JSDOC specification that can be found here: https://jsdoc.app

JSDoc is a specification for the comment format in JavaScript. This specification allows developers to describe the structure of their code, data types, function parameters, and much more using special comments. These comments can then be transformed into documentation using appropriate tools.

Working with new features, frameworks, and tools, the experience of reading documentation is a critical part of it. I have been lucky to work with projects that feature really easy to read documentation such as USWDS and Bun, but I've also had the misfortune to work with pretty terrible documentation like JSDoc. The JSDoc documentation lacks a search field which makes searching for specific items an ordeal and also does not cover many hidden use cases. It provides less than the bare minimum for what it needs to do - a lot of the time I am forced to rely on external user documentation elsewhere to use JSDoc effectively. That was why I was drawn to the search field in particular in Docusaurus.

The Svelte team followed suit but motivated by the maintainer's developer experience as they migrated the project away from TypeScript in favor of plain JSDoc comments for type annotations instead.

Even more relevant, tools like Javadoc, JSDoc, Doxygen, etc. read comments in a specific format to generate documentation. These comments do not affect readability. On the contrary, Javadocs are great for explaining how to use these entities. Combined with tools like my dear Doctest, we even get guarantees of accuracy and correctness!

Document types with JSDoc annotations

📚 JSDoc for documentation and jsdoc-to-markdown to create docs as markdown files