javascript - オブジェクトを引数として取る JS 関数の文書化

Question

JavaScript や PHP などの動的言語では、関数に引数を 1 つだけ渡すのが一般的です。この引数は、すべてのオプションをカプセル化するオブジェクトです。これらのオプションを ScriptDoc (または同様のもの) で文書化する最良の方法は何ですか?

Answer 1

JSDocを使用すると、次のように実行できます。

/**
 * @param {Object} o       Object containing function params.
 * @param {String} o.bar   Example String param.
 * @param {Number} o.baz   Example Number param.
 */
function foo(o) {
}

詳細については、JSDoc のTagParam ドキュメントの「プロパティを持つパラメーター」セクションを参照してください。