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

标签 typescript visual-studio-code jsdoc

在 VSCode 中处理 javascript/typescript 项目时,我想在注释中编写多行代码。知道 VSCode 支持注释中的 Markdown 语法,我继续写:

/**
* ```ts
* { deliverQuestionClicked: { [pageNum]: false } }
* ```
*/
deliverQuestionClicked: {},
但是,当我将鼠标悬停在该变量上时,VSCode 会以难看的方式呈现注释:
vscode_1.png
如上图所示,还有额外的 *我不想要的。
所以我想知道在注释中编写多行代码的正确方法是什么?
2020/9/25 更新
我可以确认这个问题在 VSCode 1.49.1 中不存在
代码:
class TopRow extends React.Component {
    state = {
        /**
        * ```ts
        * { deliverQuestionClicked: { [pageNum]: false } }
        * ```
        */
        deliverQuestionClicked: {},
    };
}
当我将鼠标悬停在该类属性上时,它完美地显示了 JSDoc:
image.png

最佳答案

应该已经修好了。
在 VSC 1.48 中使用此代码

class TopRow {
  state = {
    /**
    * ```ts
    * { deliverQuestionClicked: { [pageNum]: false } }
    * ```
    */
    deliverQuestionClicked: {}
  }
}
我得到
enter image description here

关于typescript - 在 VSCode 的 javascript/typescript 项目中的 JSDoc 注释中编写多行代码的正确方法是什么?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/54227909/

相关文章:

jsdoc - 如何在ubuntu的整个目录上运行jsdoc

javascript - VS 代码中的 jsDoc @callback

typescript - Browserify + typescript

typescript - 如何将索引类型与交集类型相结合

docker - 如何在 vscode 之外构建并运行 .devcontainer 文件夹?

intellij-idea - 等效于Webstorm/IntelliJ扩展选择的Visual Studio Code快捷方式

javascript - 当我们使用 css dropdown 作为共享组件时如何设置和获取表单值

JavaScript 函数比较数组中的值并返回它

python - 当我不在基础 conda 环境中时,vscode IntelliSense/代码完成不起作用

javascript - JSDoc 3 如何读取带有#include 的.c 或.h 文件? (#为非法字符)