【问题标题】:How can I use JSDoc to document class methods inherited from an external package?如何使用 JSDoc 记录从外部包继承的类方法?
【发布时间】:2021-09-29 21:21:48
【问题描述】:

我在图书馆工作。该库包含几个类,这些类从另一个包中扩展了父类。

为了方便我的用户,我希望我的库的文档包含从外部包继承的方法。

有没有办法做到这一点?目前还没有找到。

我尝试将 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()
  };

有没有办法注入来自其他地方的文档?其他想法?

干杯!

【问题讨论】:

    标签: javascript documentation jsdoc


    【解决方案1】:

    好吧,看来如果我只是将外部类的源文件(包含jsodc)添加到要解析的文件中,我的问题就解决了。对!

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2021-10-23
      • 2023-03-17
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2015-02-05
      • 1970-01-01
      相关资源
      最近更新 更多