AMD + Backbone + 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;

});

我需要生成一份易读的文档，其中Product和Products类出现在models/products模块中，但我只得到了清晰的模块和各自的类。

我想可能有人曾经遇到过这个问题。

谢谢。

注1：我确实阅读了其他帖子，我不想重复发问。

注2：抱歉我的英语很差 :S

- Exos

---

在这个网站上，寻求推荐工具和方法的方式被视为不符合要求。请查看：http://stackoverflow.com/help/on-topic - mico

我们认为最好的Stack Overflow问题中包含一些源代码，但如果你的问题通常涵盖以下内容...[...]程序员常用的软件工具；并且是关于正确使用这些工具的问题。为什么你认为这个问题不相关？我正在询问一个“程序员常用”的工具的正确使用方法，而不是寻求更好的使用方法。 - Exos

Answer 1

阅读了这篇文档之后，我明白您的问题可以通过将以下代码移至文件顶部来解决：

/**
 * @module models/products
 */

我理解您在匿名函数中写了@module，它会被忽略。

- Vijay Dev

---

有人能验证这是否是问题吗？我想主要作者不在。 - Vijay Dev

不，如果我将“模块”移到文件顶部，我会得到没有类的模块，我尝试过了（如果您查看我在描述中分享的线程），在工厂上使用“lends”但没有结果。 - Exos