Как я могу использовать JSDoc для документирования методов класса, унаследованных от внешнего пакета?

#javascript #documentation #jsdoc

Вопрос:

Я работаю над библиотекой. Эта библиотека содержит несколько классов, которые расширяют родительский класс из другого пакета.

Чтобы упростить это для моих пользователей, я хотел бы, чтобы документация моей библиотеки включала методы, унаследованные от внешнего пакета.

Есть ли способ сделать это? До сих пор я ни одного не нашел.

Я попытался скопировать jsdoc из внешнего класса (автором которого я также являюсь) в свою новую библиотеку, но это не работает, так как метод не определен в библиотеке.

Я мог бы сделать следующее, но кажется глупым добавлять код в свою библиотеку только ради документации:

   /**
   * This is a method that's actually inherited from the parent class. 
   * I'm simply copying the jsdoc over into my own lib.
   */
  doThis() {
    super.doThis()
  };
 

Есть ли способ внедрить документацию, поступающую откуда-то еще? Другие идеи?

Ура!

Ответ №1:

ну, похоже, что если я просто добавлю исходный файл внешнего класса (который содержит jsodc) в файлы для анализа, моя проблема будет решена. Да!