• Empleos
  • Sobre nosotros
  • profesionales
    • Inicio
    • Empleos
    • Cursos y retos
  • empresas
    • Inicio
    • Publicar vacante
    • Nuestro proceso
    • Precios
    • Evaluaciones
    • Nómina
    • Blog
    • Comercial
    • Calculadora de salario

0

153
Vistas
JSDoc: detección automática de métodos de clase

Mis jsdocs se parecen a lo siguiente

 module.exports = class gateio extends Exchange { /** * @class * @name gateio */ async fetchOrder (id, symbol = undefined, params = {}) { /** * @method * @name gateio#fetchOrder * @description Retrieves information on an order * @param {string} id : Order id * @param {string} symbol : Unified market symbol * @param {boolean} params.stop : True if the order being fetched is a trigger order * @param {dictionary} params : Parameters specified by the exchange api * @returns [Order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */

¿Hay alguna forma de detectar automáticamente que

  • que fetchOrder es un método
  • su nombre es fetchOrder y pertenece a la clase gateio
  • su descripción es "Recupera información sobre un pedido"
  • Ese gateio es una clase
  • ese gateio se llama gateio

¿O tengo que especificar @método, @nombre, @clase, @descripción para cada documento?

Estos @ parecen superfluos y me gustaría excluirlos si pudiera

almost 3 years ago · Juan Pablo Isaza
1 Respuestas
Responde la pregunta

0

Parece que jsdoc está confundido por module.exports = class ... . Pude hacer que funcionara así:

 /** * (description text) */ class gateio extends Exchange { /** * Retrieves information on an order * @param {string} id : Order id * @param {string} symbol : Unified market symbol * @param {boolean} params.stop : True if the order being fetched is a trigger order * @param {dictionary} params : Parameters specified by the exchange api * @returns [Order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ async fetchOrder (id, symbol = undefined, params = {}) { // ... } } module.exports = gateio
almost 3 years ago · Juan Pablo Isaza Denunciar
Responde la pregunta
Encuentra empleos remotos

¡Descubre la nueva forma de encontrar empleo!

Top de empleos
Top categorías de empleo
Empresas
Publicar vacante Precios Nuestro proceso Comercial
Legal
Términos y condiciones Política de privacidad
© 2025 PeakU Inc. All Rights Reserved.

Andres GPT

Recomiéndame algunas ofertas
Necesito ayuda