Как правильно написать многострочный код в комментарии JSDoc в проекте javascript / typcript в VSCode? - PullRequest
0 голосов
/ 17 января 2019

При работе над проектом javascript / typcript в VSCode я хочу написать многострочный код в комментарии. Зная, что VSCode поддерживает синтаксис уценки в комментариях, я продолжаю и пишу:

/**
* ```ts
* { deliverQuestionClicked: { [pageNum]: false } }
* ```
*/
deliverQuestionClicked: {},

Однако, когда я наведу указатель на эту переменную, VSCode визуально отображает комментарий:

vscode_1.png

Как показано на скриншоте выше, есть лишние *, которые мне не нужны.

Так что мне интересно, как правильно написать многострочный код в комментарии?

Ответы [ 2 ]

0 голосов
/ 17 января 2019

Просто используйте / * * / до и после комментария. Например:

/*
This is a multi line comment
I can type on a different line
Without having to worry so far
I close my multi line commen with
an asterix and a backward slash
*/
0 голосов
/ 17 января 2019

Вы можете использовать многострочный комментарий JavaScript, который начинается с / * и заканчивается * /. Вам не нужны дополнительные *.

...