【问题标题】:Output examples with html使用 html 输出示例
【发布时间】:2014-02-21 01:53:21
【问题描述】:

我想输出其中包含 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 自动“安全”输出?

【问题讨论】:

    标签: jsdoc jsdoc3


    【解决方案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

    【讨论】:

    • 但是如果你在 JSDoc 中查看它不会输出为文本吗?在我尝试此操作时,该示例实际上呈现为 html ...
    • 对不起,我刚刚意识到你提到了 3.3.0,而我现在使用的是 3.2.0,也许新的“alpha”版本已经发生了变化
    • 是的,这正是我在回答中所说的:“使用版本 3.3.0-alpha4...”和“据我所知,没有 3.3.0-alpha 之前的版本... "。
    【解决方案2】:

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

    【讨论】:

      猜你喜欢
      • 2017-09-09
      • 2011-03-07
      • 2020-11-20
      • 2012-08-01
      • 2023-03-30
      • 1970-01-01
      • 2010-09-29
      • 1970-01-01
      • 2021-02-26
      相关资源
      最近更新 更多