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