jsdoc - JSDoc を使用してコールバックを文書化する方法は?

Question

コールバック関数をパラメーターとして受け取る Javascript 関数があるとします。

var myFunction = function(onSuccess, onFailure) {...}

onSuccessの戻り値の型と引数を文書化するにはどうすればよいですか?

Answer 1

JSDoc 3.1 以降では、新しい@callbackタグを使用して、別のコメント ブロックにコールバック関数を記述することができます。その後、メソッドのドキュメントでコールバックを参照できます。

次に例を示します。

/** @class */
function MyClass() {}

/**
 * Do something.
 * @param {MyClass~onSuccess} cb - Called on success.
 */
MyClass.prototype.myFunction = function(cb) {
    // code
};

/**
 * Callback used by myFunction.
 * @callback MyClass~onSuccess
 * @param {number} resultCode
 * @param {string} resultMessage
 */

詳細については、 JSDocの使用を参照してください。

Answer 2

この機能はまだ存在しないようです。

この機能は、JSDoc 3.1 で追加されました。見る：

• http://code.google.com/p/jsdoc-toolkit/issues/detail?id=319
• https://github.com/jsdoc3/jsdoc/issues/260

関連する議論のために。