Me gustaría poder escribir JsDoc para un método abstracto en la clase principal, de modo que se aplique a todos sus herederos.
Este ejemplo es una versión extremadamente simplificada de mi caso:
class Shape { /** Does some complicated example stuff. * @param {number} myNumber a real value. * @param {boolean} myBoolean a flag. * @param {string} myString some text. * @returns {string} something important. */ doStuff(myNumber, myBoolean, myString) {} } El método doStuff no está implementado porque cada una de las (muchas) subclases lo implementa de manera diferente, pero con la misma firma y los mismos parámetros.
class Triangle extends Shape { doStuff(myNumber, myBoolean, myString) { return myBoolean ? myNumber.toString() : myString; } } Como puede ver en la captura de pantalla, las partes de texto de la documentación se heredan, pero los tipos de parámetros y el tipo de devolución se pierden. ¿Qué puedo hacer para heredar correctamente los tipos también? Intenté jugar con las @inheritdoc , @abstract , @extends , @override y @link pero sin éxito.
Tenga en cuenta que esta es una versión extremadamente simplificada, en mi código real, el bloque de documentación tiene más de 20 líneas y copiarlo en un número cada vez mayor de subclases no es factible, ya que sería una pesadilla mantenerlo.
No creo que esto sea posible, ya que es una deficiencia de JSDoc.
De todos modos, es discutible que los tipos de parámetros deben tomarse de la función de clase base respectiva.
¿Qué tal si envuelves tu método doStuff() dentro de su propio @typedef ?
https://jsdoc.app/tags-typedef.html
/** * @typedef doStuff * @type {Function} * @param {Number} myNumber * @param {Boolean} myBoolean * @param {String} myString * @returns {String} */ Y luego úsalo en extends :
class Triangle extends Shape { /** @type {doStuff} */ doStuff(){} }