docs: 📝 add JSDoc and standard for API documentation

[agmaran]

Descripción

Incluye un resumen de los cambios y el problema relacionado (en caso de que hubiera uno). Enumere las dependencias necesarias para este cambio.

Tareas realizadas (Agregue los ID de las tareas en ClickUp)

Tipo de cambio

Marque con una x dentro de los [] los que apliquen

• [] fix: Este PR corrige un error (bug).
• [] feat: Este PR agrega nueva funcionalidad.
• [] docs: Este PR agrega o mejora la documentación.
• [] test: Este PR agrega pruebas unitarias.
• [] perf: Este PR mejora el rendimiento, sin cambios funcionales.
• [] chore: un tipo general para cualquier otro tipo de commits.

Una nota en chroe: Por ejemplo, si estás implementando una sola característica y tiene sentido dividir el trabajo en múltiples commits, deberías marcar un commit como feat y el resto como chore.

Lista de Verificación

Marque con una x dentro de los [] los que apliquen

• [] He agregado las nuevas dependencias en la descripción
• [] He agregado las nuevas variables de entorno (solo los nombres y rutas) a la descripción
• [] Mi código sigue las pautas de estilo de este proyecto.
• [] He revisado mi código.
• [] He comentado mi código, particularmente en áreas difíciles de comprender.
• [] He realizado los cambios correspondientes a la documentación.
• [] Mis cambios no generan nuevas advertencias.
• [] He agregado pruebas que demuestran que mi solución es efectiva o que mi funcionalidad funciona.
• [] Las pruebas unitarias nuevas y existentes pasan localmente con mis cambios.
• [] Cualquier cambio dependiente ha sido fusionado y publicado en los módulos derivados.

[socket-security]

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/better-docs@2.7.3	environment, filesystem, shell Transitive: eval, network, unsafe	+216	216 MB	hotcto
npm/jsdoc@4.0.2	Transitive: environment, eval, filesystem, unsafe	+25	8.46 MB	hegemonic

View full report↗︎