doc comment
A comment starting with /** placed above a declaration, which editors show as documentation when you hover over it.
In more detail
TypeScript reads these JSDoc comments and displays them in tooltips and auto-complete. In plain JavaScript files, JSDoc tags such as @param can even carry types.
Related terms
- tooltip — A small text label that appears when a control is hovered or focused, describing it briefly.
- language service — The part of TypeScript that editors talk to for live errors, hover information, auto-complete, renames and quick fixes.
Taught in
- Verify Your Environment: Running tsc And Bun TypeScript — Production TypeScript