关于vscode里面的注释有疑问,请求大佬们回答,谢谢?

作者站长头像
站长
· 阅读数 16

最近在看Vue源码的时候发现 很多这样的注释 并且注释里面还能写markdown语法 鼠标悬浮就可以展示/*****/

这和我所了解的注释完全不一样我都是这样的注释/**/

或者//

去网上搜了不知道是不是我的关键字有问题 总是解决不了我的疑问,我的疑问是这种注释是使用插件还是什么样的组合键打出来?

回复
1个回答
avatar
test
2024-07-17

java doc类似,js也有个js doc功能: https://jsdoc.app/index.html

简单来说必须以/**开头,其他语法基本和java doc类似,熟悉java的程序员对这个都不陌生

你可以参考上面的文档看看js doc的语法,还可以用工具直接根据js doc生成你的类库的帮助文档。

一些可视化工具,比如你的vscode鼠标悬停,就可以直接看到代码注释功能

另外vscode也有生成js doc模板的功能,你在你要插入js doc的函数或变量上方键入/**,就会弹出这个补全提示:

answer image

此时按下TAB键或者鼠标点击补全提示就会快速生成这个js doc模板:

answer image

回复
likes
适合作为回答的
  • 经过验证的有效解决办法
  • 自己的经验指引,对解决问题有帮助
  • 遵循 Markdown 语法排版,代码语义正确
不该作为回答的
  • 询问内容细节或回复楼层
  • 与题目无关的内容
  • “赞”“顶”“同问”“看手册”“解决了没”等毫无意义的内容