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
fetchOrder
es un métodofetchOrder
y pertenece a la clase gateio
¿O tengo que especificar @método, @nombre, @clase, @descripción para cada documento?
Estos @ parecen superfluos y me gustaría excluirlos si pudiera
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