javascript 예제 AMD+백본+JSDoc3 문서화에 가장 좋은 방법



jsdoc 예제 (1)

내 코드를 문서화하는 가장 좋은 방법을 찾고 있지만 아무것도 찾지 못했습니다.

주제를 비롯하여 다른 주제를 보았지만 문제가 해결되지 않았습니다.

나는 이런 것을 가지고있다 :

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


문서를 읽은 후에는 다음 코드를 파일의 맨 위로 이동하여 문제가 해결 될 수 있음을 이해합니다.

/**
 * @module models/products
 */

나는 당신이 익명의 함수 안에 @module 을 작성 @module 때문에 무시된다는 것을 이해한다.





jsdoc3