使用快捷键可快速生成注释,Ctrl + /(Windows/Linux)或 Cmd + /(Mac)用于行注释,Shift + Alt + A 用于块注释,提升编码效率。
在 VSCode 里快速生成注释,主要依赖于快捷键、内置功能和扩展插件。掌握这些方法能显著提升编码效率。
使用快捷键快速添加行/块注释
VSCode 内置了基础的注释功能,适用于大多数编程语言:
- 行注释:选中一行或多行代码,按下 Ctrl + /(Windows/Linux)或 可生成
/* ... */
形式的注释。
使用文档注释生成函数说明
在函数上方输入特定注释符号,可自动生成结构化文档注释:
- 在 JavaScript/TypeScript 中,在函数前输入
<font face="Courier New">/** * 计算两个数的和 * @param {number} a - 第一个数 * @param {number} b - 第二个数 * @returns {number} 结果 */ function add(a, b) { return a + b; }</font>
</li></ul><H3>安装注释增强插件</H3><p>通过扩展插件可以实现更智能、统一的注释风格:</p><ul><li><strong>Document This:</strong> 自动生成 JSDoc 注释,支持 TypeScript 和 JavaScript,快捷键通常是 <font face=” ctrl alt d> 或点击灯泡提示。
基本上就这些。结合快捷键和插件,能在 VSCode 中高效生成清晰的注释。