JSDoc - 필수 매개 변수 구문 지정

Question

@JSDoc을 사용하여 자바 스크립트 라이브러리의 문서를 만듭니다. 선택적 매개 변수를 나타내는 방법을 알고 있습니다. like below

/* 
* @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.