5

JSDoc3 を使用して AMD モジュールを文書化する方法を見つけようとしています。

/**
 * Module description.
 *
 * @module path/to/module
 */
define(['jquery', 'underscore'], function (jQuery, _) {

    /**
     * @param {string} foo  Foo-Description
     * @param {object} bar  Bar-Description
     */
    return function (foo, bar) {
        // insert code here
    };
});

残念ながら、http: //usejsdoc.org/howto-commonjs-modules.htmlにリストされているパターンはどれも私にはうまくいきません。

モジュールによってエクスポートされた関数のパラメーターと戻り値をリストする適切なドキュメントを生成するにはどうすればよいですか?

4

2 に答える 2