• Jobs
  • About Us
  • professionals
    • Home
    • Jobs
    • Courses and challenges
  • business
    • Home
    • Post vacancy
    • Our process
    • Pricing
    • Assessments
    • Payroll
    • Blog
    • Sales
    • Salary Calculator

0

156
Views
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

about 3 years ago · Juan Pablo Isaza
1 answers
Answer question

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
about 3 years ago · Juan Pablo Isaza Report
Answer question
Find remote jobs

Discover the new way to find a job!

Top jobs
Top job categories
Business
Post vacancy Pricing Our process Sales
Legal
Terms and conditions Privacy policy
© 2025 PeakU Inc. All Rights Reserved.

Andres GPT

Recommend me some offers
I have an error