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

Question

我想用JSDoc和一些@example来记录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没有显示正确的文档：

我怎么解决这个问题？

Answer 1

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

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