使用字符串呈现 Markdown 代码示例 (JSDoc2MD)

Question

我在 JS 文件中使用 JSDoc 注释，并使用运行 JSDoc2MD 将这些注释呈现到降价 readme.md 文件中。我想使用来自 JSDoc 的 @example tag 在我的文档中包含代码示例。我在渲染带引号的字符串时遇到问题。

在我的 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(&quot;Do you like cheese?&quot;);

```

所以降价输出看起来不错，除了引号：

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

使用 JSDoc2MD 的其他人有这个问题吗？我刚才是不是输入错了什么？

Answer 1

这是车把的东西，试试这个：

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

请注意 this.. 周围的三重括号。请参阅 here 并查找 "triple stash".

Render Markdown Code Example with String (JSDoc2MD)