Question

我正在寻找记录代码的最佳方法，但我找不到任何东西。

我看到其他主题，包括this，但这些都无法解决我的问题。

我有这样的事情：

define([
    'backbone'
], function (Backbone) {

    /**
     * @module models/products
     */

    /**
     * Product model
     * @class
     */
    var Product = Backbone.Model.extend({
        /** @lends Product.prototype */

        /**
         * Some method
         * @param {String} name - Name of something
         * @return {something}
         */

         someMethod: function () {
             // ...
         }

    });

    /**
     * Products collection
     * @class
     */
    var Products = Backbone.Collection.extend({
        /** @lends Products.prototype */

        /**
         * @type {Product}
         */
        model: Product,


        /**
         * Some method
         * @param {String} name - Name of something
         * @return {something}
         */

         someMethod: function () {
             // ...
         }

    });

    return Products;

});

我需要生成一个清晰的文档，其中 Product 和 Products 类出现在 models / products 模块中，但是我得到了模块明确和分类。

我想有人经历过这个问题。

感谢。

PD1：我真的读过其他帖子，我不是想重复问题。

PD2：对不起，我的英语很差：S

Answer 1

阅读此doc后，我了解您的问题可以通过将以下代码移到文件顶部来解决：

/**
 * @module models/products
 */

我理解，既然你已经在匿名函数中编写了@module，那么它就会被忽略。

AMD + Backbone + JSDoc3文档的最佳方式

1 个答案: