javascript - 使用 RequireJS 和 JSDoc3 记录 Marionette 模块

Question

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

我将如何着手记录这样定义的 Marionette 模块:

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

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

然后在文档中将其连接到如下定义的 View :

//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

好的，感谢 Louis，我想出了如何让模块被识别的方法。然后我就可以随意使用它，将 View 注册为模块的类。

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

一些注意事项:

• 在 View 的@name 中，.Module1/并不是必需的，但它可以更容易地在文档网页中找到
• 在这个例子中，itemView 在技术上是私有(private)的，因为它不会被返回，但我希望能够在文档中找到它