About JSDoc.fyi

What this site is

JSDoc.fyi is an independently produced reference guide created to provide a clean, accessible overview of JSDoc's tags, syntax, guides, and configuration.

This site documents JSDoc 4.0.5 — the current stable release. Content is current as of May 2026.

It is not the official JSDoc documentation. For the official documentation and the authoritative source of truth, please use the official resources:

• Official JSDoc reference
• Official JSDoc GitHub repository

Intent

JSDoc.fyi exists to make JSDoc more approachable — with cleaner navigation, better examples, and a consistent visual presentation. Every page that has an equivalent on the official site links back to it at the bottom so you can always cross-reference or verify.

This site does not replace, compete with, or claim to supersede the official JSDoc documentation or the JSDoc project. It is a community learning resource.

Attribution & license

Content on JSDoc.fyi is original writing inspired by and referencing the official JSDoc documentation (licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)) and the JSDoc source code (licensed under the Apache License 2.0).

Official documentation

The official JSDoc documentation is maintained by the JSDoc project contributors and is the authoritative reference. When in doubt, consult the official site.