用RequireJS和JSDoc3记录Marionette模块

Question

我终于花了一些时间来正式记录我的Marionette代码，但是我遇到了一些关于JSDoc3和Marionette模块的问题。

我将如何记录像这样定义的Marionette模块：

//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
        ...
    });
}

谢谢!

Answer 1

好吧，多亏路易，我想出了如何让模块被识别。然后，我能够充分利用它，将视图注册为模块的一个类。

模块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 1/并不是真正必要的，但它使在doc网页中更容易找到。
• 在本例中，itemView在技术上是私有的，因为它不会被返回，但是我希望能够在文档中找到它