Question

我正在尝试为我的系统创建一个文档，但总有些错误。

在下面，我的班级出现在模块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...
});

由于

Answer 1

您必须使用模块名称为传递给@lends的名称添加前缀。请参阅此剪辑中的@lends语句，我根据您问题中的代码进行了改编：

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

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

使用上面的@lends，我可以显示myFunction1，并进行正确记录。

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

1 个答案: