JSDoc을 사용하여 특정 상황에서 가변 개수의 매개 변수를 문서화하는 방법

Question

내 함수가 첫 번째 요소가 != 3 일 때 두 번째 및 세 번째 매개 변수 만 사용하는 것과 같습니다. JSDoc을 사용하여이 동작을 어떻게 문서화 할 수 있습니까?

getTimeframe: function(timeframe, since, until) { 
/* 
* @param {Number} timeframe Can be 0, 1, 2 or 3 
* @param {Number} since Optional when timeframe !== 3 
* @param {Number} until Optional when timeframe !== 3 
*/ 
... 

} 

Answer 1

은 지금까지 나는 다음은 jsdoc의 핵심은 함수가 하나 명 이상의 서명이있는 것을 나타 내기 위해서 @also을 사용하는 것입니다 (3)와 현재 할 수있는 최선의 것을 알고있다. 그럼 당신이이 getTimeframe 기능에 대한 두 개의 서명을 만들 것 등

/** 
* When the <code>timeframe</code> parameter is not 3... 
* 
* @param {number} timeframe Can be 0, 1, 2. 
* @param {number} [since] blah. 
* @param {number} [until] blah. 
* 
* @also 
* 
* When the <code>timeframe</code> is 3, then... 
* 
* @param {number} timeframe Set to 3. 
*/ 
function getTimeframe(timeframe, since, until) { 

} 

, 다른 적용 할 때 하나 명의 서명을 적용 할 때 설명에 밖으로 철자 있습니다.

(참고 : 나는 위의() 예를 들어 1 instanceof Number가 false 때문에 같은 경우 number하지 Number를 사용하여 선호하는 반면에 typeof 1"number" 및 typeof Number(1)도 "number"입니다..)