JSDoc,指的是函数描述中的标识符

时间:2014-04-12 19:03:05

标签: javascript jsdoc

有没有办法强调功能描述中的标识符? 例如,在这个简化的代码段中:

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

似乎很难区分参数名称,外部变量名称和其他单词,只需查看说明。

当然,在实际代码中,标识符更具自我描述性,如果用骆驼案例或蛇案例编写,它们可以相对容易地被识别,但它仍然是一个问题。

1 个答案:

答案 0 :(得分:2)

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

如果您使用的是jsdoc 3.x,也可以打开Markdown插件并使用Markdown标记`page`