用jsdoc记录mongoose模型方法

我试图用jsdoc来记录mongoose模型方法。模型的方法属于模型，因此我希望将其视为其成员方法

该文件还包含一个顶级

@模块模型

行

/**
 * @constructor
 */
var MySchema = new Schema({
  title: {
    type: String,
    required: true
  }
});

/**
 * My method
 *
 * @function myMethod
 * @memberof MySchema
 * @this MySchema
 * @param {ObjectId} object
 * @params {Array} roles, defaults to all
 * @returns Participant or null
 */
 MySchema.method('myMethod', function(object, roles) {
   // ...
 });

目前，我收到一个模块页面，其中包含指向我的类定义的链接，以及一个记录类定义的页面，但该方法没有出现在任何这些页面上。当我删除

@memberof

时，该方法将显示在模块页面上。不过我想把它放在课堂上

---

我缺少jsdoc文档的哪一部分？

您必须明确说明模块：

@memberof module:models~MySchema

事实上，jsdoc不会推断当您指定

MySchema

时，您指的是当前模块中的

MySchema

实体

---

实际上，这与

@相同。如果您将其修改为具有模块名称，那么在文档中关于
此
的部分将有一个指向
MySchema
定义的链接
我还必须添加
@实例
作为标记，或者它认为我的方法是静态的。