3

JSDoc3 を使い始めるのに問題があります。最も重要なことは、@params が表示されないことです。

これが私のテストソースです：

/**
 * Testing JsDoc3.
 * Why isn't this working `better`?
 */
function foo(bar) {
    console.log(+bar);
}

/**
   A function with params.
   @param {string} baz
   @param {...number} bim
 */
function goo(baz/*, ...bim */) {

}

/**
 * Hello, is this thing on?
 * @namespace bop
 * @type {object}
 */
var bop = {

    sting: function(WHO) {
        console.log(WHO);
    },

    buzz: function(when, why) {

    }

};

そして、私は走ってい./jsdoc -r -l test.jsます。問題は、私が得た出力がかなり当たり障りのないものであり、多くの情報が不足していることです:

JSDoc3 出力

パラメータ情報がないのはなぜ?! デフォルトのテンプレートを使用しています。デフォルトのテンプレートは、パラメーターを表示しないほど平凡ですか? それとも私は何か間違ったことをしていますか？

JSDoc3 のテンプレートをいくつか探してみましたが、良いものを見つけることができませんでした。機能し、実際に役立つ情報が含まれている優れたものを知っている場合は、共有してください.

4

2 に答える 2

4

JSDoc3 の以前のバージョンでグローバル オブジェクトをドキュメント化する際に問題がありましたが、最新バージョンではすべてうまく機能しています。

最新バージョンで再試行すると、goo グローバル関数のパラメーターが取得されます。

しかし、より良い説明を取得したい場合は、ルールに従う必要があります

@param {type} param_name パラメータの説明 @param タグ、タイプ、パラメータ名、パラメータの説明

@param タグが欠落しているため、foo グローバル関数は情報を提供しません。これがあなたのコードの私の出力です

グローバル関数

名前空間オブジェクト

元のコードにいくつかのタグを追加しました:

/** * JsDoc3 のテスト。* なぜこれが機能しないのbetterですか? * @method * @param {Object} bar Som バーの値 */ function foo(bar) { console.log(+bar); }

/**
   A function with params.
   @param {string} baz
   @param {...number} bim
   @returns {boolean} return false because we're testing
 */
function goo(baz/*, ...bim */) {
    return false;
}

/**
 * Hello, is this thing on?
 * @namespace bop
 * @type {object}
 */
var bop = {

    /**
    * Hello, is this thing on?
    *
    * @method
    * @param {object} WHO Some Param
    * @memberof bop
    */
    sting: function(WHO) {
        console.log(WHO);
    },

    /**
    * I'm public
    *
    * @method
    * @param {object} when Some Param when
    * @param {object} why Some Param why
    * @memberof bop
    */
    buzz: function(when, why) {
        _buzz(when, why);
    },

    /**
    * I'm inner (private)
    *
    * @inner
    * @method
    * @param {object} when Some Param when
    * @param {object} why Some Param why
    * @memberof bop
    */
    _buzz: function(when, why) {
        console.log(when);
    }

};
于 2013-01-05T23:34:10.310 に答える