如何在不破坏格式的情况下在 JSDoc 中编写包含 javascript 注释的模板文字？答案

【问题标题】：How to write template literal that contains javascript comments in JSDoc without breaking format?如何在不破坏格式的情况下在 JSDoc 中编写包含 javascript 注释的模板文字？
【发布时间】：2019-04-12 01:16:17
【问题描述】：

我想使用带有一些@example 的JSDoc 来记录javascript 函数，但它破坏了JSDoc。

我想要的代码示例是这样的（我想要的版本）：

stripJSDoc(`/**
* Hello
*/

function Hello();

/**
* World
*/

function World();`)

// => ['Hello', 'World']

我会将上面插入到下面。

/**
 * Strip JSDoc text from given string.
 *
 * @example
 *
 * // I will insert above example code here.
 * 
 */

function stripJSDoc();

现在，我已经插入了，JSDoc格式坏了。

/**
 * Strip JSDoc text from given string.
 *
 * @example
 *
 * stripJSDoc(`/**
 * * Hello
 * */
 * 
 * function Hello();
 * 
 * /**
 * * World
 * */
 * 
 * function World();`)
 * 
 * // => ['Hello', 'World']
 * 
 */

function stripJSDoc();

如您所见，格式现在已损坏，我可以转义某些字符，但随后 VSCode 提示将被损坏。

转义代码：

/**
 * Strip JSDoc text from given string.
 *
 * @example
 *
 * stripJSDoc(`/**
 * * Hello
 * *\/
 * 
 * function Hello();
 * 
 * /**
 * * World
 * *\/
 * 
 * function World();`)
 * 
 * // => ['Hello', 'World']
 * 
 */

function stripJSDoc();

现在 VSCode 没有显示正确的文档：

我该如何解决这个问题？

【问题讨论】：

似乎有一些关于这个错误的建议：github.com/jsdoc3/jsdoc/issues/821

标签： javascript typescript escaping jsdoc

【解决方案1】：

您是正确的，您必须在 jsdocs 的示例块中转义 */。这是必需的，因为 JavaScript 不支持嵌套的多行 cmets

悬停消息中的前导星号是您无法解决的known bug。它计划在 TypeScript 3.5 中修复，直到 5 月才会被 VS Code 接收。修复错误后，您可以按照these instructions 在 VSCode 中升级您的 TypeScript 版本。（TypeScript 支持 VS Code 的 JavaScript 支持）

【讨论】：