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;

有没有办法对 JSDoc 进行排序以防止 HTML 自动“安全”输出？

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 仍处于 alpha 阶段。据我所知，没有 3.3.0-alpha 之前的版本......它可以解决这个问题，也没有解决方法。提示修复的错误报告在这里。

score 0 · Accepted Answer

没有办法解决这个问题。如果要在最终的 HTML JSDoc 页面中显示 < 和 > 符号，则需要使用 HTML 转义码。

2 回答 2