JSDOC 注釋格式

Question

我在 static 屬性吸氣劑中的 polymer class 中有一個屬性，定義如下，並在屬性上方對其進行評論。

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

這些塊被視為 markdown，因此您的<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.

Answer 2

我設法解決了這個問題，正如我們所知。

• < 代表 [小於號][1] ( < )。
• > 代表 [大於號][2] ( > )。

將<替換為< 和 > 與> 在評論中將解決問題。