AMD +主干+ JSDoc3文档的最佳方式

Question

我正在寻找最好的方式来记录我的代码，但我什么也找不到。

我看到了其他的主题，包括这，但是这些都不能解决我的问题。

我有这样的事情：

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;

});

我需要生成一个清晰的文档，其中Products类位于模型/products模块中，但是我通过单独的方法使模块清除，类得到分离。

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

谢谢。

PD1:我真的读过其他的文章，我不是在重复问题。

PD2:对不起，我的英语很差。

Answer 1

在阅读了这个文档之后，我知道您的问题可以通过将以下代码移到文件的顶部来解决：

/**
 * @module models/products
 */

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