Пример рендеринга кода уценки со строкой (JSDoc2MD)
Я использую комментарии JSDoc в файле JS и запускаю JSDoc2MD, чтобы отобразить эти комментарии в файле readme.md уценки. Я хочу включить примеры кода в мою документацию, используя тег @example из JSDoc. У меня проблемы с отображением строки с кавычками.
В моих комментариях JS у меня есть:
/** @example
* // returns true
* yesNo("Do you like cheese?");
*/
Этот комментарий становится следующим в JSON:
{
"examples": [
"// returns true\nyesNo(\"Do you like cheese?\");"
]
}
У меня есть пользовательская настройка шаблона руля, которую JSDoc2MD использует для генерации readme. В моем руле шаблон у меня есть:
```js
{{#each examples}}
{{this}}
{{/each}}
```
Сгенерированный файл readme имеет имя html вместо кавычек:
```js
// returns true
yesNo("Do you like cheese?");
```
Таким образом, результат уценки выглядит хорошо ожидаемо для кавычек:
// returns true
yesNo("Do you like cheese?");
Кто-нибудь еще работает с JSDoc2MD с этой проблемой? Я просто что-то здесь не так набрал?
1 ответ
Это руль, попробуйте это:
```js
{{#each examples}}
{{{this}}}
{{/each}}
```
обратите внимание на тройные скобки вокруг this
.. смотрите здесь и ищите "тройной тайник".