JSDOC 注释格式

Question

我在静态属性 getter 内的聚合物类中有一个属性，定义如下，在属性上方有关于它的注释。

  /**
  * 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.

不知何故，在生成文档 JSDOC 的时候不理解 <text> 的评论。

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

Answer 1

据我们所知，我设法解决了这个问题。

• < 代表 [小于号][1] (
• > 代表 [大于号][2] ( > )。

将评论中的< 替换为< 和> 替换为> 将解决问题。