jsdoc - htmlでの出力例

Question

次のような HTML を含む例を出力したいと考えています。

* @example
*     <div ng-app="reportingBuilderApp">
*         <div ng-view></div>
*     </div>

しかし、現時点ではHTMLとして「安全に」レンダリングしますが、テキストとして欲しいのですが、現時点では以下のように例を書く必要があります(実際のJSではもっと面倒で醜いです)

* @example
*     &lt;div ng-app="reportingBuilderApp"&gt;
*         &lt;div ng-view&gt;&lt;/div&gt;
*     &lt;/div&gt;

HTMLが自動的に「安全に」出力されるのを防ぐためにJSDocをソートする方法はありますか?

score 1 · Accepted Answer

バージョン 3.3.0-alpha4 を使用して、次のテストファイルを使用します。

/**
 * @example
 * <div ng-app="reportingBuilderApp">
 *     <div ng-view></div>
 * </div>
 */
function foo() {
}

jsdoc の出力に正しく表示される例を取得します。

名前が示すように、3.3.0-alpha4 はまだアルファ版です。私の知る限り、この問題を修正した 3.3.0-alpha より前のバージョンはなく、回避策もありません。修正を促したバグレポートはこちらです。

2 に答える 2