1. ホーム
  2. javascript

[解決済み] インラインJSDocを使用して、paramがオプションであることを示すには?

2022-05-11 07:43:59

質問

のJSDoc wikiによると パラメータ を使うと、@param がオプションであることを示すことができます。

/**
    @param {String} [name]
*/
function getPerson(name) {
}

を指定し、パラメータ インライン を使って

function getPerson(/**String*/ name) {
}

で、以下のように組み合わせると、大丈夫なんです。

/**
    @param [name]
*/
function getPerson(/**String*/name) {
}

ですが、可能であれば全てインラインで行う方法があれば教えていただきたいです。

どのように解決するのですか?

Google Closure Compiler を使って、こんな方法がありました。 型式表現 . のように、型の後に等号を付けるのです。 function test(/**String=*/arg) {}