WebStorm 2025.2 Help

配置代码风格

如果公司已有特定编码规范,创建源代码时则必须遵循这些规范。 WebStorm 会帮助您维护所需的代码风格。

IDE 提供两个预定义方案: 项目 方案和 默认 方案。

  • 项目 方案中,配置的设置仅适用于当前项目。

    这些设置存储在 codeStyles 文件夹下的 .idea 中,并随项目通过 VCS 进行共享。

    当您修改项目的代码风格设置后,IDE 会创建该文件夹。

  • 默认 方案(IDE 级别方案)中,配置的设置适用于所有选定 默认 代码风格方案的项目。

    这些设置存储在 WebStorm 配置目录 下的 codestyles 文件夹中,且不会通过 VCS 共享。

如果您想将项目的代码风格方案用作默认方案,可以将其复制到 IDE 级别。 反过来也可以:您可以用某个 IDE 级别方案的设置覆盖当前项目的设置,并与团队其他成员共享。

配置方案

在 WebStorm 中,代码风格设置是面向特定语言的,因此需要为项目中使用的每种语言分别配置。 您还可以从其他语言复制设置并应用于另一种语言。

为某种语言配置代码风格

  1. Ctrl+Alt+S 打开设置,然后选择 编辑器|代码样式

    要配置 新项目 的方案,请转到 文件| 新建项目设置|新项目的首选项对话框| 编辑器| 代码样式

  2. 选择要为其配置代码风格的语言。

  3. 选择要配置的代码风格 方案项目 方案或其中一个 IDE 级别方案

  4. 浏览各个选项卡并配置代码风格偏好设置。

    使用对话框右侧部分预览更改。 更改设置时,预览区域会出现一个或多个闪烁区域以突出显示更改内容。

从其他语言应用代码风格

对于大多数受支持的语言,您可以从其他语言或框架中复制代码风格设置。

  1. Ctrl+Alt+S 打开设置,然后选择 编辑器|代码样式

    要配置 新项目 的方案,请在主菜单中转到 文件| 新建项目设置|新项目的首选项对话框| 编辑器| 代码样式

  2. 选择要为其配置代码风格的语言。

  3. 选择要修改的代码风格 方案项目 方案或其中一个 IDE 级别方案

  4. 在显示的列表中,选择要复制其代码风格的语言。

    从其他语言设置代码风格

使用 EditorConfig 按目录级别管理代码风格

WebStorm 允许您使用 EditorConfig 支持(默认在 设置 对话框(Ctrl+Alt+S )中启用)为每个文件集分别管理所有代码风格设置。 您只需在包含要定义代码风格的文件的根目录中放置一个 .editorconfig 文件。 在项目中可以包含任意数量的 .editorconfig 文件,从而为不同模块指定不同的样式。

.editorconfig 文件中的所有选项都会应用于其所在目录及所有子目录,并覆盖当前项目的代码风格。 如果 .editorconfig 中未定义某项内容,则使用项目设置中的值。

.editorconfig 文件中的所有选项分为以下几类:

  • 标准选项,例如 indent_sizeindent_style 等。 这些选项不包含任何特定领域的前缀。

  • 通用 IntelliJ 选项具有 ij_ 前缀,适用于所有语言:

    • ij_visual_guides

    • ij_formatter_off_tag

    • ij_formatter_on_tag

    • ij_formatter_tags_enabled

    • ij_wrap_on_typing

    • ij_continuation_indent_size

    • ij_smart_tabs

  • 通用 IntelliJ 选项可被许多(但不是全部)语言支持。 它们以 ij_any 为前缀,例如 ij_any_brace_style

  • 语言特定的 IntelliJ 选项以 ij_<lang>_ 为前缀,其中 <lang> 为语言领域 ID(通常为小写语言名称),例如 ij_java_blank_lines_after_imports

添加 .editorconfig 文件

  1. 项目 视图中,右键单击包含要定义代码风格的文件的源目录,并从上下文菜单中选择 新建|EditorConfig

  2. 选择要定义的属性以便 WebStorm 为其创建 stub,或将所有复选框留空以手动添加所需属性。

  3. 要预览对代码风格设置的更改将如何影响实际源文件,请在 .editorconfig 文件的装订区域单击 眼睛图标 ,并选择一个受其影响的源文件。 预览将在右侧打开。

    editorconfig 预览

    您可以在预览窗格中进行更改,以尝试和测试配置更改的效果,而无需担心对源代码造成不必要的更改:关闭 .editorconfig 文件时,所有这些更改都会被放弃。

最后修改日期: 2025年 9月 26日