JSDoc lets you describe a JavaScript API beside the code that implements it, then turn those comments into browsable HTML reference pages. Add a comment that starts with /**, use tags such as @param and @returns to describe inputs and outputs, and run the JSDoc command-line tool on your source file. TypeScript can also read some JSDoc annotations to check JavaScript types, but that is a separate use from generating documentation pages.
What is JSDoc?
“JSDoc” refers both to a documentation comment and tag convention for JavaScript and to the generator that reads those comments. Developers place comments alongside source code to explain API elements such as modules, namespaces, classes, methods, and parameters. The JSDoc tool can use that information to produce an HTML documentation site. JSDoc’s getting-started guide describes both meanings.
JSDoc is not a programming language or a replacement for TypeScript. Its generator creates reference pages; TypeScript’s JSDoc support uses annotations for type analysis in JavaScript files.
How to write a JSDoc comment
Put the documentation block immediately before the code it describes. As the JSDoc documentation advises, “JSDoc comments should generally be placed immediately before the code being documented.” The parser recognizes documentation comments beginning with /**; ordinary /* comments and certain other star patterns are ignored.
Do these 3 things before closing this tab:
1Repair Windows errors before they cause bigger problems2Scan for outdated or missing drivers - takes under a minute3Clear out junk files and repair common Windows errors#1 Best Overall
- Read Before You Buy — No Video Output: These adapters support charging and USB 2.0 data transfer, but cannot transmit video signals. Except for standard USB webcams (which use USB data only), they are not compatible with HDMI/DisplayPort cables, video-capable USB-C hubs, or docking stations with video output.
- Convert USB-A Ports to USB-C: Designed to connect USB-C earphones, cables, flash drives, card readers, and other USB-C accessories to standard USB-A ports. Plug-and-play with no drivers or software required.
- Aluminum Alloy Housing: Built with a sturdy aluminum alloy shell that aids in heat dissipation and protects against daily wear and scratches. Designed to maintain a stable and secure connection.
- Compact & Travel-Friendly: The ultra-compact design allows the adapter to stay plugged into your device without blocking adjacent ports or adding bulk, reducing wear and tear on your original USB ports.
- 12-Month Warranty: Backed by a 12-month manufacturer warranty for peace of mind. Designed to meet strict quality control standards for reliable everyday performance.
Start with a plain-language description. Add tags when structured details—such as parameter types and return values—will help someone understand or use the API.
/**
* Adds two numbers and returns their sum.
* @param {number} left - The first number.
* @param {number} right - The second number.
* @returns {number} The sum of the inputs.
*/
function add(left, right) {
return left + right;
}Here, @param describes each input, including its type and explanation, and @returns describes the result. The JSDoc @param guide documents this pattern. For object-shaped or reusable types, JSDoc also provides type expressions and tags such as @typedef and @property. Its @type reference covers unions, arrays, record-like objects, nullable values, optional parameters, callbacks, and named type definitions.
Rank #2
- 5-in-1 USB-C Hub: Experience comprehensive connectivity featuring a Power Delivery input, two USB-A 2.0 ports, a USB-A 3.0 port, and an HDMI port. (Note: The USB-C power delivery input port is only for connecting an external wall charger to power your laptop and cannot power peripheral devices.)
- 90W Pass-Through Charging: Achieve optimal charging with 90W pass-through power to your laptop, supported by a total input of 100W, with the hub reserving 10W for operational efficiency. (Note: Wall charger not included.)
- Quick Data Transfers: Accelerate your productivity with rapid data transfers using a high-speed 5Gbps USB 3.0 port and two 480Mbps USB 2.0 ports.
- 4K HDMI Display: Enhance your visual experience with a hub capable of delivering 4K resolution at 30Hz in both mirror and extend modes. Please note that this hub is compatible with MacBook (macOS 12 and newer), Windows 10 and 11, ChromeOS, and laptops equipped with DP Alt Mode and Power Delivery. Note: This device is not compatible with Linux.
- What You Get: Anker USB-C Hub (5-in-1, 4K HDMI), welcome guide, 18-month warranty, and our friendly customer service.
Generate HTML documentation
Once JSDoc is available in your project environment, pass a source file to its command-line program. The official quick start uses jsdoc book.js; by default, the generated HTML goes into an out/ directory in the current working directory. The JSDoc quick start also notes that the built-in default template can be edited or replaced.
jsdoc book.jsThe command reads the comments it recognizes and generates documentation pages from the source file. The out/ location is a default, not a fixed requirement: project configuration can change file selection and output behavior.
Rank #3
- Sleek 7-in-1 USB-C Hub: Features an HDMI port, two USB-A 3.0 ports, and a USB-C data port, each providing 5Gbps transfer speeds. It also includes a USB-C PD input port for charging up to 100W and dual SD and TF card slots, all in a compact design.
- Flawless 4K@60Hz Video with HDMI: Delivers exceptional clarity and smoothness with its 4K@60Hz HDMI port, making it ideal for high-definition presentations and entertainment. (Note: Only the HDMI port supports video projection; the USB-C port is for data transfer only.)
- Double Up on Efficiency: The two USB-A 3.0 ports and a USB-C port support a fast 5Gbps data rate, significantly boosting your transfer speeds and improving productivity.
- Fast and Reliable 85W Charging: Offers high-capacity, speedy charging for laptops up to 85W, so you spend less time tethered to an outlet and more time being productive.
- What You Get: Anker USB-C Hub (7-in-1), welcome guide, 18-month warranty, and our friendly customer service.
Configure which files JSDoc reads
As a project grows, a JSON configuration file can control how JSDoc processes source. Pass it with -c, for example jsdoc -c jsdoc.json. The configuration guide also documents JavaScript configuration modules for supported versions.
Configuration can select or exclude source paths, filter file names, tell the parser to treat files as module or script, collect command-line options, select plugins, control tag dictionaries, and change template behavior. The documented default include pattern targets .js, .jsdoc, and .jsx files; the default exclusion pattern ignores underscore-prefixed files and directories. These are defaults that a project can override, not universal rules for every setup.
Rank #4
- Dual Converters, Infinite Potential：Includes 2× USB C male to USB A female adapters and 2× USB A male to USB C female adapters. Perfect for a wide range of uses—tablets with Bluetooth keyboards, expand USB ports on macbook, and more. Two different converters for all your daily needs
- Next-Level 10Gbps & 3A Charging: No more slow 480Mbps, this usb to usb c adapter has a transfer speed of up to 10Gbps, allowing you to do more transferring in less time. This usb adapter fits both USB A and USB C charger, supporting up to 3A fast charging
- Upgraded Exquisite Craftsmanship: With an aluminum alloy housing and metal connector, the usbc to usb adapter is extremely durable and sturdy. Rigorously tested to withstand more than 10,000 times of plugging and unplugging, ensuring long-lasting performance
- Broad Compatible: The usb c to usb adapter widely supports all USB C/ USB A devices like laptops, tablets, cellphones, car chargers, and phone chargers. Such as compatible with MacBook Pro/Air 2023/2022, Thunderbolt 4/3 Devices,Apple MagSafe Watch 9/8/7/SE/Ultra, iPad Pro 2022/2021, Samsung Galaxy S23/S20/S10, and iPhone 17/16/15 Pro. Plug and play
- Please Note: To reach 10Gbps speed, keep the cable under 3.3 ft. For USB A Male to USB C adapters, try flipping the USB C connector. USB C Male to USB A adapters support bidirectional 10Gbps transfer within 3.3 ft
If an option appears both in the configuration and on the command line, JSDoc gives precedence to the command-line value. That is useful to remember when a one-off command appears to behave differently from the project configuration.
Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.JSDoc generation and TypeScript annotations serve different purposes
Use JSDoc’s generator when the goal is browsable API reference pages. TypeScript’s JSDoc support is for supplying type information in JavaScript files so TypeScript can analyze them. The syntax overlaps, and a project can use both, but the two are not interchangeable.
What’s actually slowing this PC down?
Pick the symptom - the matching free tool is one click away.
Best Value
- 5-in-1 Connectivity: Equipped with a 4K HDMI port, a 5 Gbps USB-C data port, two 5 Gbps USB-A ports, and a USB C 100W PD-IN port. Note: The USB C 100W PD-IN port supports only charging and does not support data transfer devices such as headphones or speakers.
- Powerful Pass-Through Charging: Supports up to 85W pass-through charging so you can power up your laptop while you use the hub. Note: Pass-through charging requires a charger (not included). Note: To achieve full power for iPad, we recommend using a 45W wall charger.
- Transfer Files in Seconds: Move files to and from your laptop at speeds of up to 5 Gbps via the USB-C and USB-A data ports. Note: The USB C 5Gbps Data port does not support video output.
- HD Display: Connect to the HDMI port to stream or mirror content to an external monitor in resolutions of up to 4K@30Hz. Note: The USB-C ports do not support video output.
- What You Get: Anker 332 USB-C Hub (5-in-1), welcome guide, our worry-free 18-month warranty, and friendly customer service.
The TypeScript handbook’s JSDoc reference lists supported tags including @type, @param, @returns, @typedef, @callback, and @template. It also describes documentation tags such as @deprecated, @see, and @link as usable in both JavaScript and TypeScript.
TypeScript does not recognize every JSDoc tag. The handbook distinguishes documentation tags from other tags: only documentation tags are supported in TypeScript files, while other supported tags apply in JavaScript files. Check the handbook’s supported-types list rather than assuming a tag understood by the JSDoc generator will also affect TypeScript analysis.
TypeScript also supports JSDoc-specific @import annotations to bring declarations into scope for use in comments. This does not import a module at runtime; those imported names are available only in JSDoc comments for type checking.
Quick Recap
Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.
Quick wins for a faster PC:
Scan for outdated or missing drivers - takes under a minuteDriver Scan →Repair Windows errors before they cause bigger problemsFix Now →
