autojsdoc/examples/example.js

CLI tool for auto-generating JSDoc comments in JavaScript and TypeScript files

/**
 * subtract - Automatically generated function description.
 * @param {any} a - a of the subtract function.
 * @param {any} b - b of the subtract function.
 * @returns {number} - The result of subtract.*/
function subtract(a, b) {
  return a - b;
}

/**
 * add - Automatically generated function description.
 * @param {any} a - a of the add function.
 * @param {any} b - b of the add function.
 * @returns {number} - The result of add.*/
function add(a, b) {
  return a + b;
}

/**
 * sorting - Automatically generated function description.
 * @param {Array} arr - arr of the sorting function.
 * @returns {number} - The result of sorting.*/
function sorting(arr) {
  return arr.sort((a, b) => a - b);
}