Question

我有一个庞大的现有Javascript代码库，其中大部分是由自定义库创建的类组织的。其中大部分与此类似：

/** 
 * @memberOf nameSpace.subNameSpace1
 * @class 
 */
nameSpace.subNameSpace1.ClassName1 = nameSpace.subNameSpace2.ClassName2.subClass({
  ctor: function () {

  },

  /**
   * method1 is a special method that does special things.
   * @param config {Object}
   * @returns {Boolean}
   */
  method1: function (config) {
  },

  method2: function () {
  }
})

subClass方法在Object原型上定义，并创建一个继承自它所调用的对象的类。我想记录以这种方式创建的类的方法，但不幸的是，jsDoc没有提取类似于上面的method1文档的文档（该类的文档本身工作正常）。如何以jsDoc理解的方式记录这些方法？

Answer 1

事实证明，使用npm的最新版本的jsdoc解决了这个问题，并且如果使用@function

正确注释，它会认识到这些方法是给定类的一部分

如何使用jsDoc记录从函数调用返回的类

1 个答案: