在VSCode中的javascript/typescript项目中，在JSDoc注释中编写多行代码的正确方法是什么？

Question

在 VSCode 中处理 javascript/typescript 项目时，我想在注释中编写多行代码。知道VSCode在评论中支持markdown语法，我继续写：

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

然而，当我将鼠标悬停在该变量上时，VSCode 以丑陋的方式呈现评论：

如上图所示，多出*我不要的

所以我想知道在注释中写多行代码的正确方法是什么？

更新2020/9/25

我可以确认这个问题在 VSCode 1.49.1

中不存在

代码：

class TopRow extends React.Component {
    state = {
        /**
        * ```ts
        * { deliverQuestionClicked: { [pageNum]: false } }
        * ```
        */
        deliverQuestionClicked: {},
    };
}

当我将鼠标悬停在 class 属性 上时，它完美地显示了 JSDoc：

Answer 1

可以使用JavaScript的多行注释，以/*开头，以*/结尾。你不需要额外的 *.

Answer 2

只需在注释前后使用/* */。例如：

/*
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
*/

Answer 3

在JSDoc-format,

JSDoc 注释的基本格式规则。

• 每行包含一个星号，星号必须对齐
• 每个星号后必须跟一个 space 或一个换行符（第一个和最后一个除外）
• 每行星号前的唯一字符必须是白色space 个字符
• 一行注释必须以/**开始，以*/结束
• 多行注释不允许第一行 /** 之后的文本（使用选项 "check-multiline-start"）

You can optionally specify the option "check-multiline-start" to enforce the first line of a multiline JSDoc comment to be empty.

TypeScript in Visual Studio Code

To disable JSDoc comment suggestions in TypeScript,
set "typescript.suggest.completeJSDocs": false.

添加评论

• 按 Ctrl+Alt+C 两次
• 或select 'Comment code' 从您的上下文菜单
• 或在代码行上方插入/**。

更多信息visit

Answer 4

一定已经修复了。

在 VSC 1.48 中使用此代码

class TopRow {
  state = {
    /**
    * ```ts
    * { deliverQuestionClicked: { [pageNum]: false } }
    * ```
    */
    deliverQuestionClicked: {}
  }
}

我明白了