JSDoc을 사용하여 콜백을 문서화하는 방법은 무엇입니까?</p> <pre><code>var myFunction = function(onSuccess, onFailure) {...} </code></pre> <p>가 어떻게 <code>onSuccess</code>의 반환 형식 및 인수 문서화 않습니다

Question

는 매개 변수로 콜백 함수를 취 자바 스크립트 기능을 감안할 때?

Answer 1

JSDoc 3.1 이상에서는 새로운 @callback 태그를 사용하여 별도의 주석 블록에 콜백 함수를 설명 할 수 있습니다. 그런 다음 해당 메서드의 문서에서 콜백을 참조 할 수 있습니다.

다음은 예입니다 :

/** @class */ 
function MyClass() {} 

/** 
* Do something. 
* @param {MyClass~onSuccess} cb - Called on success. 
*/ 
MyClass.prototype.myFunction = function(cb) { 
    // code 
}; 

/** 
* Callback used by myFunction. 
* @callback MyClass~onSuccess 
* @param {number} resultCode 
* @param {string} resultMessage 
*/ 

자세한 내용은 Use JSDoc를 참조하십시오.

Answer 2

아직이 기능이 존재하지 않습니다.

이 기능은 JSDoc 3.1부터 추가되었습니다. 참조 :

• http://code.google.com/p/jsdoc-toolkit/issues/detail?id=319
• https://github.com/jsdoc3/jsdoc/issues/260

을 관련 논의.