JSDoc
A convention for writing documentation comments above JavaScript and TypeScript code, using tags such as @param and @deprecated.
In more detail
Editors show JSDoc in hover tooltips, and a @deprecated tag makes the editor strike through uses of the old prop. Storybook Autodocs reads the same comments.
Related terms
- deprecation — Marking a feature as outdated and scheduled for removal, while it still works, so users have time to move to its replacement.
- Autodocs — The Storybook feature that builds a documentation page for a component from its stories, TypeScript types and JSDoc comments.
- TypeScript — JavaScript with added type annotations, checked by a compiler before the code runs.
Taught in
- Storybook & Component Driven Development Workflows — Design Systems & Component Engineering
- System Governance: Changesets, Semantic Versioning & Deprecation — Design Systems & Component Engineering