使用 // 注释格式进行 Intellisense

MBe*_*Ber 5 javascript intellisense visual-studio-code

TL;DR: VSCode“编辑器悬停”框的 JS 注释附加行为从何而来?它可以适应使用//注释吗?

编辑 .js/.ts 文件时,当鼠标悬停在对变量的任何引用(由设置控制Editor > Hover)上时,VSCode 会显示一个框。

/** I'm a comment */
const someVariable = 'Me';

console.log(someVariable);
Run Code Online (Sandbox Code Playgroud)

someVariable将鼠标悬停在最后一行时会产生以下结果:

在悬停中显示注释的变量的屏幕截图。

仅当该框的注释部分是以两个星号开头的多行注释(变量、对象属性或函数上方的一行或多行)时才会出现,这与 Intellisense 对 JSDoc 的使用一致。非常有用,但一些团队成员更喜欢将//注释放在声明变量的短行末尾。有没有办法让 VSCode 将这些行尾注释考虑到变量/属性,或者我是否必须将每个相关注释转换为/**这样才能看到它?

Nat*_*her 4

这个 2 分钟的视频对我了解使用 jsDoc 格式的优势非常有帮助。我将开始输入自动完成注释的命令,而不是 vscode 中的Ctrl K Ctrl C/**,类似于///在 c# 中输入的 Visual Studio 代码以自动生成注释模板等。以下是视频: 在 JavaScript 和 TypeScript 中快速编写 JSDoc 注释