markdown - 使用字符串渲染 Markdown 代码示例 (JSDoc2MD)

Question

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

在我的 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 一起工作的其他人有这个问题吗？我只是在这里输入错误吗？

score 0 · Accepted Answer

这是车把的事情，试试这个：

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

this请注意..周围的三重括号，请参见此处并查找“三重存储”。

1 回答 1