用html输出示例

Question

我想输出其中包含HTML的示例，例如

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

但是目前它将它“安全地”呈现为HTML，但是我希望它作为文本，目前我需要编写如下的示例（这在实际的JS中更加乏味和丑陋）

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

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

Answer 1

使用版本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之前没有版本...它有解决这个问题的方法，并没有解决方法。提示修复的错误报告是here。

Answer 2

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