Javascript 使用jsdoc注释具有多个类的requirejs模块

Javascript 使用jsdoc注释具有多个类的requirejs模块,javascript,class,requirejs,jsdoc,Javascript,Class,Requirejs,Jsdoc,我试图使用jsdoc版本3.2.2,我认为它不喜欢我的编码风格,我无法让类的方法显示在它的文档中 这就是我的设置: define(["lib"], function(lib){ var myModule = {}; myModule.staticMethod = function(param){ // do something } myModule.MyClass = function(param){ // construct

我试图使用jsdoc版本3.2.2,我认为它不喜欢我的编码风格,我无法让类的方法显示在它的文档中

这就是我的设置:

define(["lib"], function(lib){

    var myModule = {};

    myModule.staticMethod = function(param){
        // do something
    }

    myModule.MyClass = function(param){
        // constructor
    }

    myModule.MyClass.prototype.myMethod = function(param){
        // an instance method of MyClass
    }

    myModule.OtherClass = function(param){
        // constructor
    }

    myModule.OtherClass.prototype.otherMethod = function(param){
        // an instance method of OtherClass
    }

    return myModule;
})
在上的文档之后,我添加了以下jsdoc注释:

define(["lib"], function(lib){

    /**
    * @exports myModule
    */
    var myModule = {};

    /**
    * A static Method of myModule
    * @param {string} param A parameter
    */
    myModule.staticMethod = function(param){
        // do something
    }


    /**
    * @class
    * @classdesc This is my class
    * @param {string} param A parameter to the constructor.
    */
    myModule.MyClass = function(param){
        // constructor
    }

    /**
    * A method of MyClass 
    * @param {string} param A parameter to myMethod.
    */
    myModule.MyClass .prototype.myMethod = function(param){
        // an instance method of myClass
    }

    myModule.OtherClass = function(param){
        // constructor
    }

    myModule.OtherClass.prototype.otherMethod = function(param){
        // an instance method of OtherClass 
    }

    return myModule;
})
我没有尝试记录第二个类,因为到目前为止它没有按预期工作。创建myModule和MyClass的文档,MyClass属于myModule,staticMethod作为myModule的静态成员进行文档记录。到目前为止一切都很好。但是myMethod在myModule的文档中被记录为MyClassmyMethodparam。我尝试使用@memberOf,但无法使其工作,以下示例都使myMethod从文档中消失:

@memberOf MyClass
@memberOf class:MyClass
@memberOf myModule.MyClass
@memberOf module:myModule.class:MyClass

@memberOf MyClass.prototype
@memberOf class:MyClass.prototype
@memberOf myModule.MyClass.prototype
@memberOf module:myModule.MyClass.prototype
@memberOf module:myModule.class:MyClass.prototype
以下内容使其成为MyClass的成员,但作为myModule.MyClassmyMethodparam

我尝试了@instance标记,但它再次从文档中删除了myMethod


我怎样才能使myMethod显示为myClass的实例方法?

你有没有想过这个问题?也许,如果是这样,你可以发布你的问题的答案?我还需要更好地理解如何评论RequireJS模块。不幸的是,我没有。这是一个业余项目,所以对我来说并不重要。我发现了另一个答案:@fraxture,一个文档一个模块就是一个类,我试图在一个模块中包含两个类,但我想我会将每个类重构成一个requireJS模块,以使其正常工作。不过谢谢你。
@memberOf module:myModule.MyClass