jsdoc中函数参数名称的标记？

Question

如何在jsdoc / jsdoc3中标记或创建引用函数参数。

例如：

/** 
 * Build xxx.
 * cfg is optional.
 *
 * @param {Object} cfg  config
 * @function
 */
function build(engine, cfg) { ... }

用于在cfg描述中包裹cfg is optional.的标记？

Answer 1

我看到one possible way并附在tt HTML标记中：

/**
 * Repeat <tt>str</tt> several times.
 * @param {string} str The string to repeat.
 * @param {number} [times=1] How many times to repeat the string.
 * @returns {string}
 */
repeat: function(str, times) { ... }