Как написать шаблонный литерал, содержащий комментарии javascript в JSDoc, не нарушая формат?

Question

Я хочу задокументировать функцию javascript, используя JSDoc с некоторыми @example, но это нарушает 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 не поддерживает вложенные многострочные комментарии

Ведущие звезды в сообщении при наведении - это известная ошибка , которую вы не можете обойти.Его планируется исправить в TypeScript 3.5, который не будет подхвачен VS Code до мая.После исправления ошибки вы можете обновить версию TypeScript в VSCode, следуя этим инструкциям .(TypeScript поддерживает VS поддержку кода JavaScript)