1

非常にJavaScriptを多用するプロジェクトにjsdocを使用しています。コード ドキュメントを取得するために、jsdoc に grunt を介して html ファイルを作成させます。

これまでのところ、次のように「memberof」キーワードを使用して、モジュールにプロパティとメソッドを正常に割り当てました。

/**
 * Short description of this module
 *
 *
 * @module hse-catalog
 */
jQuery(document).ready(function($) {
    'use strict';

    /**
     * @namespace catalog
     * @memberof module:hse-catalog
     */
    catalog = {

        selector: {
            /* Stuff in here */
        },

        /**
         * Initializes the module.
         *
         * @memberof module:hse-catalog
         */
        init: function() {
            // do init
        },

        /**
         * Indicates whether the module is ready to load.
         *
         * @return {boolean} true or false
         * @memberof module:hse-catalog
         */
        isReady: function() {
            // do stuff
        }

        /**
         * Initializes the catalog page breadcrumb.
         * @deprecated out of order
         * @memberof module:hse-catalog
         */
        initBreadcrumb: function() {
            // do stuff
        }
    };
});

これにより、すべてのモジュールを一覧表示する非常に優れた html ドキュメントが作成されます。そこでこれらのモジュールの 1 つをクリックすると、このモジュールのすべてのプロパティとメソッドが表示されます。ここまでは順調ですね。

しかし、本当の問題は、モジュールを特定の名前空間に割り当てたいということです。どうやってそれを行うのですか?jsdoc はこれをまったくサポートしていますか?

4

0 に答える 0