javascript - 如何在不破坏格式的情况下在 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 的示例 block 中转义 */。这是必需的，因为 JavaScript 不支持嵌套的多行注释

悬停消息中领先的星星是known bug你无法解决。它计划在 TypeScript 3.5 中修复，直到 5 月才会被 VS Code 接受。错误修复后，您可以按照 these instructions 在 VSCode 中升级您的 TypeScript 版本。 . (TypeScript 为 VS Code 的 JavaScript 支持提供支持)