Exemple de code de démarquage avec chaîne (JSDoc2MD)

Question

J'utilise des commentaires JSDoc dans un fichier JS et j'exécute JSDoc2MD pour restituer ces commentaires dans un fichier readme.md markdown. Je veux inclure des exemples de code dans ma documentation en utilisant le @example tag de JSDoc. J'ai des problèmes avec le rendu d'une chaîne avec des guillemets.

Dans mes JS commentaires J'ai:

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

Ce commentaire est le suivant dans JSON:

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

J'ai une configuration de modèle de guidon personnalisés qui JSDoc2MD utilise pour générer le readme. Dans mon modèle de guidon je:

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

Le readme généré a le nom HTML au lieu des guillemets:

```js 

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

``` 

Ainsi, la sortie de démarquage semble bien attendre pour les guillemets:

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

Quelqu'un d'autre qui travaille avec JSDoc2MD a ce problème? Est-ce que je viens de taper quelque chose de mal ici?

Answer 1

c'est une chose guidon, essayez ceci:

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

les notes triple crochets autour this .. voir here et chercher "planque triple".