首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >JSDOC注释格式

JSDOC注释格式
EN

Stack Overflow用户
提问于 2019-10-16 19:01:47
回答 1查看 76关注 0票数 0

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

代码语言:javascript
复制
  /**
  * 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生成同样的文档,我遇到了一个奇怪的问题,在生成的文档中,这就是在属性上提到的注释是什么样子的。

代码语言:javascript
复制
when textElement is empty, textElement ( tag) is used for limited text instead of advanced text features.

不知何故,在生成文档时,JSDOC在注释中不理解<text>

任何关于这方面的见解都将是有益的,谢谢:)

EN

回答 1

Stack Overflow用户

发布于 2019-10-18 15:41:58

正如我们所知,我设法解决了这个问题。

  • &lt;代表小于号(< ).
  • &gt;代表大于号(>)。

将注释中的<替换为&lt;,并将>替换为&gt;将解决此问题。

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/58411774

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档