JSDoc is a markup language used to annotate JavaScript source code files. By adding JSDoc comments to your code, you can automatically generate API documentation and provide IDEs with intelligent hints and type checking.
JSDoc comments start with /** and end with */, with each line prefixed by * .
@param - Parameter description | @returns / @return - Return value | @typedef - Custom type | @callback - Callback type | @example - Example code | @deprecated - Deprecated | @see - Reference link | @throws - Exception description
✅ Function declarations | ✅ Arrow functions | ✅ Class methods | ✅ Async functions | ✅ Generator functions | ✅ Default parameters | ✅ Destructured parameters | ✅ Rest parameters | ✅ TypeScript type annotations
Yes, completely free to use. No registration or login required.
No. All processing happens in your browser. Your code never leaves your device. Works offline too.
Yes. The tool can parse TypeScript function signatures, automatically extract parameter types and return types.
Yes. After generation, you can manually edit the JSDoc comments, add descriptions, examples, custom tags, etc.
Supports function declarations, arrow functions, class methods, async functions, generator functions, default parameters, destructured parameters, rest parameters, and more.