1. 安装相关插件
在使用vscode进行代码编写时,我们需要通过安装相关插件来辅助我们完成代码格式的规范化。其中最基本的是Prettier插件,这是一个强大的代码格式化工具。要在Vscode中安装Prettier,我们只需要打开编辑器,点击左侧的扩展按钮,搜索Prettier插件,点击“Install”即可完成安装。
2. 配置Prettier插件
2.1 配置文件格式(MacOS/Linux)
在macOS或者Linux系统上,我们需要先打开终端,输入cd ~
, 进入到用户目录下。然后输入code .
命令打开Vscode编辑器。新建一个文件夹进行配置,使用mkdir prettier
命令即可创建。接着我们在该文件夹下新建一个.prettierrc
文件。
{
"semi": true,
"tabWidth": 2,
"singleQuote": true,
"trailingComma": "es5",
"printWidth": 100
}
在这个文件中,我们可以设置该插件的一些基本配置,比如是否添加分号,是否使用单引号等等。通过这个配置文件,我们可以很容易地设置Prettier的行为。具体的配置参数可以在官方文档中找到。
2.2 配置文件格式(Windows)
对于Windows系统来说,我们同样需要先打开终端,进入用户目录下。在编辑器中,我们需要按下Ctrl + Shift + P
快捷键,然后输入“Prettier: Create Configuration File”进入插件的配置文件。同样地,新建一个.prettierrc
文件,并在其中进行相关的配置即可。
3. 配置Vscode保存自动格式化代码
在完成Prettier插件的基本配置后,我们需要进一步设置Vscode自动保存并格式化代码的功能。在Vscode的设置中,有两个与保存有关的设置:Format On Save和Editor: Format On Save Timeout。
3.1 Format On Save
开启Format On Save设置后,Vscode会尝试在保存文档之前自动进行格式化操作。在默认情况下,这个选项是关闭的,需要我们手动设置为true。
"editor.formatOnSave": true,
3.2 Editor: Format On Save Timeout
对于比较大的代码文件,格式化可能需要一些时间,这时候可能会影响我们的使用体验。在这种情况下,我们可以设置Editor: Format On Save Timeout来延迟自动格式化的时间,以便在保存之后一段时间才进行。
"editor.formatOnSaveTimeout": 1000,
如果没有设置这个值,那么默认情况下编辑器会在保存之后立即格式化代码。一般情况下,这个值可以设置为1000ms。
总结
通过本文的介绍,我们可以了解到如何在Vscode中设置保存格式化代码的功能,使我们的代码更加规范化、易读易懂。而这个设置可以通过安装Prettier插件和添加相关的配置文件实现。除此之外,我们还可以通过设置Format On Save和Editor: Format On Save Timeout来进一步优化我们的使用效率。在今后的开发过程中,我们可以将这些功能运用到工作中,提高我们编写代码的效率和质量。