Documentación de JSDoc con ESLint

• JSDoc es una herramienta para generar documentación de API a partir de comentarios en tu código fuente de JavaScript.

Generación de documentación con JSDoc

• Para generar documentación con JSDoc, primero necesitas instalar JSDoc en tu proyecto. Puedes hacerlo con npm o yarn:

npm install --save-dev jsdoc

• Luego, puedes escribir comentarios de documentación en tu código JavaScript utilizando la sintaxis de JSDoc. Aquí tienes un ejemplo de cómo se ven estos comentarios

/**
 * Esta es una función de ejemplo.
 *
 * @param {string} nombre - El nombre de la persona a saludar.
 * @returns {string} Un saludo personalizado.
 */
function saludar(nombre) {
  return `¡Hola, ${nombre}!`;
}

• Una vez que hayas escrito tus comentarios de documentación, puedes generar la documentación HTML ejecutando JSDoc desde la línea de comandos.

npm run docs

• Esto generará un directorio docs/ en tu proyecto que contiene un archivo index.html que puedes abrir en tu navegador para ver la documentación de tu proyecto.

Configuración de JSDoc

• Puedes configurar JSDoc utilizando un archivo de configuración jsdoc.json. Puedes especificar la ubicación de este archivo de configuración utilizando la opción -c cuando ejecutas JSDoc desde la línea de comandos.

jsdoc -c jsdoc.json

• Aquí tienes un ejemplo de un archivo de configuración JSDoc que especifica la ubicación de los archivos de origen y la plantilla que se utilizará para generar la documentación.

{
  "source": {
    "include": ["./stores", "test"],
    "exclude": ["node_modules"]
  },
  "opts": {
    "destination": "./docs/"
  }
}