JSDOC Формат комментариев - PullRequest
0 голосов
/ 16 октября 2019

У меня есть свойство в классе полимера внутри 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> в комментарии.

Любое понимание этого будет полезно, спасибо :)

1 Ответ

0 голосов
/ 18 октября 2019

Мне удалось решить проблему, поскольку мы знаем, что.

  • &lt; означает [знак меньше чем] [1] (<). </li>
  • &gt; означает [знак больше, чем] [2] (>).

Замените < на &lt; и> на &gt; в комментарии, чтобы решить проблему.

...