Javascript 使用RequireJS和JSDoc3记录木偶模块

我终于花了一些时间来正式记录我的木偶代码，但我在JSDoc3和木偶模块方面遇到了一些问题

我将如何记录定义如下的木偶模块：

//Module1.js
define([... , 'views'], function(..., 'views'){
    "usestrict";

    //Marionette Module definition:
    return function(...marionette module params...){
        ...
    }
}

//views.js
define([...], function(...){
    "usestrict";

    var itemView = Marionette.ItemView.extend({
        ...
    };

    //Uses itemView in a region
    return Marionette.Layout.extend({
        ...
        //do stuff with itemView
        ...
    });
}

然后在文档中将其连接到如下定义的视图：

//Module1.js
define([... , 'views'], function(..., 'views'){
    "usestrict";

    //Marionette Module definition:
    return function(...marionette module params...){
        ...
    }
}

//views.js
define([...], function(...){
    "usestrict";

    var itemView = Marionette.ItemView.extend({
        ...
    };

    //Uses itemView in a region
    return Marionette.Layout.extend({
        ...
        //do stuff with itemView
        ...
    });
}

?

---

谢谢

好的，多亏了路易斯，我才知道如何识别模块。然后，我就能够将视图作为类注册到模块中

模块1.js：

/** @module Module1 */
define([... , 'views'], function(..., 'views'){
    "usestrict";

    /** @lends module:Module1 */

    //Marionette Module definition:
    return function(...marionette module params...){
        ...
    }
}

和View.js：

define([...], function(...){
    "usestrict";

    /**
    * @name module:Module1.Module1/Views/itemView
    * @constructor
    */
    var itemView = Marionette.ItemView.extend(
    /** @lends module:Module1.Module1/Views/itemView.prototype */
    {
        ...
    };

    /**
    * @name module:Module1.Module1/Views/layoutView
    * @constructor
    */
    return Marionette.Layout.extend(
    /** @lends module:Module1.Module1/Views/layoutView.prototype */
    {
        ...
        //do stuff with itemView
        ...
    });
}

几点注意：

• 在视图的@name中，.Module1/实际上不是必需的，但它使在文档网页中更容易找到
• 在本例中，itemView在技术上是私有的，因为它不会被返回，但我希望能够在文档中找到它

---

您说“我在JSDoc3和木偶模块方面遇到了一些问题。”您遇到了哪些问题？也有一些介绍了做这件事的一般方法。谢谢你的链接！我不知道我怎么会在自己的搜索中漏掉它。为了回答你的问题，我得到了一个空白的index.html模板。多亏了你的链接，我明白了！现在发布答案。