JSDoc - 必須パラメータの構文を指定します。

Question

私はJJDocを使用して、JavaScriptライブラリのドキュメントを作成しています。私はオプションのパラメータを示す方法を知っています。以下のように

/* 
* @param {string} [somebody] - Somebody's name. 
*/ 
function sayHello(somebody) { 
    if (!somebody) { 
     somebody = 'John Doe'; 
    } 
    alert('Hello ' + somebody); 
} 

私のAPIのいくつかのパラメータは必須であることを示したいと思います。 JSDOCを使ってそれを示す方法。 私は見つからない JSDoc tags-param

Answer 1

パラメータをオプションとしてマークしない限り、パラメータは必須とみなされます。あなたがする必要があるものは何もありません。 somebodyパラメータを必須にするには、角かっこを削除するだけです。

@param {string} somebody - Somebody's name.