JSDOC评论格式

Question

我在静态属性获取器内部的聚合物类中有一个属性，定义如下，并在属性上方对此有注释。

  /**
  * when textElement is empty, textElement (<text> tag) is used for limited text instead of advanced text features.
  * @name textElement
  * @alias textElement
  * @memberof ABC
  * @type {Boolean}
  */
  textElement: {
    type: String,
    value: ''
  },

[我正在使用JSDOC生成相同的文档，并且遇到一个奇怪的问题，在生成的文档中，这是关于属性的注释的外观。

when textElement is empty, textElement ( tag) is used for limited text instead of advanced text features.

以某种方式，在不理解注释中的<text>的情况下生成文档JSDOC时。

任何对此的见解都会有所帮助，谢谢:)

Answer 1

这些块被视为减价，因此<text>被视为不可转换的html。

使用反引号`<text>`来使标记转义，或使用\<来转义“小于”符号。

例如：

  * when textElement is empty, textElement (`<text>` tag) is used for limited text instead of advanced text features.

  * when textElement is empty, textElement (\<text> tag) is used for limited text instead of advanced text features.