启用保存时自动格式化并配置默认工具可统一代码风格。通过设置editor.formatOnSave: true、安装如Prettier等格式化插件、在项目中指定默认格式化程序及使用.vscode/settings.json进行项目级配置,确保团队协作一致性。

VSCode 的代码格式化功能能帮助开发者保持代码风格统一,提升协作效率。通过合理配置,你可以让编辑器在保存时自动美化代码,支持多种语言和格式化工具。以下是实用的配置方法。
启用保存时自动格式化
最基础也最常用的设置是开启保存时自动格式化,避免手动操作。
- 打开 VSCode 设置(Ctrl + ,)
- 搜索 format on save
- 勾选 Editor: Format On Save
也可以在 settings.json 中手动添加:
“editor.formatOnSave”: true
选择合适的格式化工具
不同语言需要对应的格式化插件。常见搭配如下:
- javaScript/typescript:使用 Prettier 或内置格式化器
- python:推荐 autopep8、black 或 yapf
- html/css/scss:Prettier 支持良好
- go:安装 Go 插件后默认使用 gofmt
以 Prettier 为例,安装插件后,在项目根目录添加配置文件 .prettierrc:
{ “semi”: true, “singleQuote”: true, “tabWidth”: 2 }
设置默认格式化程序
确保 VSCode 知道用哪个工具格式化代码,尤其是安装了多个插件时。
- 右键点击代码文件,选择“格式化文档”
- 如果未指定,默认工具可能无法工作
- 点击弹出提示中的“配置默认格式化程序”
- 选择如 Prettier – Code formatter
也可在 settings.json 中指定:
“[javascript]”: { “editor.defaultFormatter”: “esbenp.prettier-vscode” }
项目级配置优先于全局设置
团队协作时,建议将格式化规则写入项目配置,保证一致性。
- 在项目根目录创建 .vscode/settings.json
- 加入格式化相关配置
- 提交到版本控制,所有成员生效
示例项目配置:
{ “editor.formatOnSave”: true, “editor.tabSize”: 2, “[python]”: { “editor.defaultFormatter”: “ms-python.black-formatter” } }
基本上就这些。正确配置后,VSCode 能在你保存文件时自动完成代码美化,减少低级风格问题。关键是选对工具、设好默认程序,并让规则可共享。不复杂但容易忽略细节。