9

コードを文書化する最良の方法を探していますが、何も見つかりません。

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;

});

製品クラスと製品クラスがモデル/製品モジュールに表示される、読みやすいドキュメントを生成する必要がありますが、モジュールを明確にし、クラスを別々に取得します。

この問題を経験した人がいると思います。

ありがとう。

PD1: 私は本当に他の投稿を読んでいます。質問を重複させようとしているわけではありません。

PD2: 下手な英語ですみません:S

4

1 に答える 1

1

このドキュメントを読んだ後、次のコードをファイルの先頭に移動することで問題を解決できることがわかりました。

/**
 * @module models/products
 */

@module匿名関数内に記述したため、無視されることを理解しています。

于 2015-11-18T05:19:27.523 に答える