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

AMD + Backbone + JSDoc3 best way to document

本文关键字：文档 方式 AMD+Backbone+JSDoc3      更新时间：2023-09-26

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

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

我有这样的东西：

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类将插入模型/产品模块中，但我将模块清除，并将类分开。

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

谢谢。

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

PD2：对不起，我英语不好：S

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

/**
 * @module models/products
 */

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

相关文章：