vscode添加/** */注释快捷键
-
/** */
是什么
/**......*/
注释若干行,并写入javadoc文档。每个文档注释都会被置于注释定界符
注释文档将用来生成HTML格式的代码报告,所以注释文
档必须书写在类、域、构造函数、方法,以及字段(field)定义之前。注释文档由两部分组成——描述、块标记。
你再调用类和方法的时候会出现提示,内容就是你写的注释。就好像文档帮助一样。类似"字符串".toString(),鼠标放在toString()上时出现的api说明。
/*......*/
注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述。一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适的位置。和
/* */
相比,/* */
就是//
的多行版
举例:
2.在vscode中添加快捷键
- 打开VSCode,点击左下角的设置按钮(齿轮图标)
- 在下拉菜单中选择“用户代码片段”。
- 在弹出的菜单中选择“新建全局代码片段”。
- 在弹出的输入框中输入文件名,例如javascript.json。
- 在弹出的编辑器中输入以下代码:
{
"Print to console": {
"prefix": "comment",
"body": [
"/**",
" * $1",
" */"
],
"description": "Generate /** */ comment block"
}
}
- 保存文件。
现在,当你在一个JavaScript文件中输入comment并按下回车键,就会生成/** */注释块,并且光标会定位在注释块中的第一行,你可以在其中输入注释内容。