Search 300+ developer tools...
K
Tools
Blog
Browse Tools
Premium
Tools
Markdown
JSDoc to Markdown
JSDoc to Markdown
Convert JSDoc comments to Markdown documentation
About this Tool
JavaScript Code with JSDoc
/** * Calculate the sum of two numbers * @param {number} a - The first number * @param {number} b - The second number * @returns {number} The sum of a and b * @example * add(5, 3) * // returns 8 */ function add(a, b) { return a + b; } /** * Fetch user data from API * @param {string} userId - The user ID * @param {Object} [options] - Optional configuration * @param {boolean} [options.cache=true] - Enable caching * @returns {Promise<Object>} User data object * @throws {Error} If user not found * @deprecated Use fetchUserById instead * @since 1.0.0 */ async function getUser(userId, options = {}) { // Implementation }
Convert to Markdown
Supported JSDoc Tags
• @param - Function parameters
• @returns / @return - Return value
• @example - Code examples
• @deprecated - Deprecation warnings
• @since - Version information
Was this tool helpful?
Yes, very helpful!
Could be better
Share Your Experience
Help others discover this tool!
Share on
Share
Frequently Asked Questions - JSDoc to Markdown
What is JSDoc to Markdown?
Is JSDoc to Markdown free to use?
Does JSDoc to Markdown work offline?
Is my data safe when using JSDoc to Markdown?
Do I need to create an account to use JSDoc to Markdown?
