javascript - JSDoc，引用函数描述中的标识符

Question

有没有办法在函数描述中强调一个标识符？ 例如，在这个简化的片段中:

function a () {
  var page;
  ...
  /**
   * Reads data from page starting with line.
   * @param {number} line
   */
  function readSomething (line) {
    ...
  }
}

好像能分清参数名、外层变量名之类的话就很好了，看描述就好了。

当然，在实际代码中，标识符更具有 self 描述性，如果用驼峰式或蛇形式编写，它们相对容易被识别，但这仍然是一个问题。

Answer 1

你必须自己标记它们。执行此操作的基本方法是使用 HTML 标记:<code>page</code>

如果你使用的是 jsdoc 3.x，也可以开启 Markdown 插件并使用 Markdown 标记 `page` .