使用 RequireJS 和 JSDoc3 记录木偶模块答案

【问题标题】：Documenting a Marionette Module with RequireJS and JSDoc3使用 RequireJS 和 JSDoc3 记录木偶模块
【发布时间】：2014-03-23 09:39:58
【问题描述】：

我终于花一些时间来正式记录我的 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
        ...
    });
}

谢谢！

【问题讨论】：

您说“我在 JSDoc3 和 Marionette 模块方面遇到了一些问题。”你遇到的这些问题是什么？还有answers 涵盖了执行此操作的一般方法。
感谢您的链接！我不知道我在自己的搜索中是如何错过它的。
为了回答你的问题，我得到了一个空白的 index.html 模板。感谢您的链接，我想通了！现在发布答案。

标签： javascript requirejs marionette jsdoc

【解决方案1】：

好的，感谢 Louis，我知道如何让模块被识别。然后我就可以搞砸它，让视图注册为模块的类。

模块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 在此示例中在技术上是私有的，因为它不会被返回，但我希望能够在文档中找到它

【讨论】：