代码之家  ›  专栏  ›  技术社区  ›  Sara

使用字符串(JSDoc2MD)渲染标记代码示例

  •  2
  • Sara  · 技术社区  · 9 年前

    我在JS文件中使用JSDoc注释,并运行JSDoc2MD将这些注释呈现为markdown自述文件。md文件。我想使用 @example tag 来自JSDoc。我在渲染带引号的字符串时遇到了问题。

    在我的JS评论中,我有:

    /** @example
     * // returns true
     * yesNo("Do you like cheese?");
    */
    

    在json中,此注释如下:

    {
    "examples": [
          "// returns true\nyesNo(\"Do you like cheese?\");"
        ]
    }
    

    我有一个自定义车把模板设置,JSDoc2MD使用它来生成自述文件。在我的车把模板中,我有:

    ```js
    {{#each examples}}
    {{this}}
    {{/each}}
    ```
    

    生成的自述文件使用html名称而不是引号:

    ```js
    
    // returns true
    yesNo("Do you like cheese?");
    
    ```
    

    所以markdown输出看起来不错,除了引号:

    // returns true
    yesNo("Do you like cheese?");
    

    其他使用JSDoc2MD的人有这个问题吗?我刚才打错了吗?

    1 回复  |  直到 9 年前
        1
  •  0
  •   Lloyd    9 年前

    这是一个车把的东西,试试这个:

    ```js
    {{#each examples}}
    {{{this}}}
    {{/each}}
    ```
    

    注意周围的三个括号 this 看见 here 寻找“三藏”。