Добавьте описание каждого примера в 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>.