使用 JSDoc + RequireJS + BackboneJS 的模块和类答案

【问题标题】：Modules and classes using JSDoc + RequireJS + BackboneJS使用 JSDoc + RequireJS + BackboneJS 的模块和类
【发布时间】：2014-02-11 08:21:36
【问题描述】：

我正在尝试为我的系统创建文档，但总是出错。

下面，我的Class出现在模块MyModule中，完美！但是我的函数没有出现在文档中！

你知道问题出在哪里吗？

define([
    'underscore',
    'backbone'
], function(_, Backbone) {
    'use strict';

/**
 * MyModule
 *
 * @module MyModule
 */

var MyModule = {};

/**
 * Class description
 *
 * @class MyModule.View
 * @extends Backbone.View
 * @memberOf module:MyModule
 * @abstract
 */

MyModule.View = Backbone.View.extend(

   /** @lends MyModule.View  */

   {

    /**
     * myFunction1
     *
     * @param {object} hello Hello World!
     */

    myFunction1: function(hello) { }


   }

});

/**
 * Class description
 *
 * @class MyModule.Model
 * @extends Backbone.Model
 * @memberOf module:MyModule
 * @abstract
 */

MyModule.Model = Backbone.Model.extend();
    //etc...
});

谢谢

【问题讨论】：

标签： javascript backbone.js requirejs jsdoc

【解决方案1】：

您必须在传递给@lends 的名称前加上模块名称。请参阅此片段中的@lends 语句，我改编自您问题中的代码：

MyModule.View = Backbone.View.extend(
    /** @lends module:MyModule.MyModule.View  */
    {

    /**
     * myFunction1
     *
     * @param {object} hello Hello World!
     */
    myFunction1: function(hello) { }
   });

使用上面的@lends，我可以让myFunction1 出现，并正确记录。

【讨论】：