JSDoc에서 각 예제에 개별적으로 설명 추가

Question

각 코드 예제에 개별적으로 설명을 추가하고 싶습니다. 예 :

/** 
* Test function, normal desciption 
* 
* THE DESCRIPTION OF THE EXAMPLE HERE 
* @example 
* fooBar("foo", "bar"); 
* 
* THE DESCRIPTION OF ANOTHER EXAMPLE HERE 
* @example 
* fooBar("bar", "foo", false); 
*/ 
function fooBar (param1, param2, param3) { 
} 

JSDoc에서이 작업을 수행 할 수 있습니까? 그렇다면 어떻게?

Answer 1

http://code.google.com/p/jsdoc-toolkit/wiki/TagExample의 하단에있는 메모에 따르면

HTML 마크 업을 사용하여 복잡한 예제 블록을 빌드하고 <code>을 사용하여 실제 예제 코드를 인용 할 수 있습니다. 설명 부분을 HTML 내부에 넣을 수 있지만 <code> 외부에 넣을 수 있습니다.