使用字符串渲染 Markdown 代码示例 (JSDoc2MD)答案

【问题标题】：Render Markdown Code Example with String (JSDoc2MD)使用字符串渲染 Markdown 代码示例 (JSDoc2MD)
【发布时间】：2016-05-24 03:34:44
【问题描述】：

我在 JS 文件中使用 JSDoc cmets 并运行 JSDoc2MD 将这些 cmets 呈现到 markdown readme.md 文件中。我想使用来自 JSDoc 的 @example tag 在我的文档中包含代码示例。我在渲染带引号的字符串时遇到了麻烦。

在我的 JS cmets 我有：

/** @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 的人遇到这个问题吗？我是不是在这里打错了？

【问题讨论】：

【解决方案1】：

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

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

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

【讨论】：