【问题标题】:JSDoc, referring to identifiers in a function descriptionJSDoc,指函数描述中的标识符
【发布时间】:2014-04-13 20:00:55
【问题描述】:

有没有办法在函数描述中强调标识符? 例如,在这个简化的 sn-p 中:

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

好像可以很好的区分参数名、外层变量名等字眼,看描述就好了。

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

【问题讨论】:

    标签: javascript jsdoc


    【解决方案1】:

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

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

    【讨论】:

      猜你喜欢
      • 2017-02-17
      • 2019-09-23
      • 2017-05-19
      • 1970-01-01
      • 1970-01-01
      • 2011-09-21
      • 2021-03-09
      • 1970-01-01
      • 2017-11-22
      相关资源
      最近更新 更多