配置代码样式

配置代码样式如果公司存在某些编码指南,则在创建源代码时必须遵循这些指南。 WebStorm 帮助您维护所需的代码样式。

这个IDE带有两个预定义的方案: 项目 方案和 默认 方案。

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

这些设置存储在 代码样式 文件夹下的 .idea 中,并通过 VCS 与项目一起共享。

在您为项目修改代码样式设置后,IDE 将创建文件夹。

在 默认 方案(IDE级别的方案)中,您配置的设置将应用于所有已选择 默认 代码样式方案的现有项目。

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

如果您想将项目代码样式方案用作您的默认方案,您可以将其复制到 IDE 级别。 另一种方式也是可行的:您可以使用 IDE 级别方案中的设置覆盖您当前的项目设置,并与您的团队其他成员共享。

只能有一个 项目 代码风格方案。 在 IDE 级别,您可以有多个方案。 多个项目可以引用同一 IDE 级别的代码样式方案。

配置方案在 WebStorm,代码样式设置是特定于语言的,因此您需要为项目中使用的每种语言分别进行配置。 您还可以从一种语言复制设置并将其应用于另一种语言。

为某种语言配置代码样式按下 Ctrl+Alt+S 打开设置,然后选择 编辑器|代码样式。

要配置 用于新项目 的方案,请转到 文件 | 新建项目设置 | 用于新项目的 设置 | 编辑器 | 代码样式。

选择您要为其配置代码样式的语言。

选择您要配置的代码样式 方案: 项目 方案或 IDE级别的方案之一。

请点击 挨着 默认 的方案,然后选择 复制 以创建该方案的副本。

浏览各个选项卡并配置代码样式偏好。

使用对话框右侧预览更改。 当您更改设置时,预览区域中会出现一个或多个闪烁区域,强调这些变化。

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

对于 C#、Visual Basic 以及其他 .NET 特定语言,不支持在语言之间复制样式。

按下 Ctrl+Alt+S 以打开设置,然后选择 编辑器|代码风格。

要配置 用于新项目 的方案,请在主菜单中转到 文件 | 新建项目设置 | 用于新项目的 设置 | 编辑器 | 代码样式。

选择您要为其配置代码样式的语言。

选择您要修改的代码样式 方案: 项目 方案或 IDE 级方案 之一。

请点击 设置从 位于右上角。

只有在可以应用来自另一种语言的代码样式设置时,才会显示此链接。

从出现的列表中,选择语言以复制代码样式。

仅适用的设置会从另一种语言复制,其他设置保持不变。

使用 EditorConfig 在目录级别管理代码样式要使用 EditorConfig,请确保在设置中启用了 EditorConfig 插件。 按 Ctrl+Alt+S 打开设置,然后选择 插件。 点击 已安装 选项卡。 在搜索框中,输入 EditorConfig。 有关插件的更多信息,请参阅 插件管理。

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

.editorconfig 文件中的所有选项都会应用于它所在的目录以及所有子目录,并覆盖当前项目的代码样式。 如果在 .editorconfig 中未定义任何内容,则从项目设置中获取。

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

标准选项,例如 indent_size、 indent_style 等。 这些选项没有任何特定领域的前缀。

适用于所有语言且带有 ij_ 前缀的通用 IntelliJ 选项:

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__ 前缀开始,其中 是语言域 ID(通常是小写语言名称),例如, ij_java_blank_lines_after_imports。

相同的选项可以被定义为通用选项和特定语言选项,例如, ij_<...>_brace_style。 语言特定选项的优先级高于通用或泛型选项。

添加一个.editorconfig文件在 项目 视图中,右键点击包含您想要定义代码样式的文件的源目录,然后从上下文菜单中选择 新建 | EditorConfig。

选择您想要定义的属性,以便 WebStorm 为它们创建存根,或者将所有复选框留空以手动添加所需的属性。

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

您可以在预览窗格中进行更改,以试验和测试您的配置更改如何反映,而无需担心对源代码进行不必要的更改:当您关闭 .editorconfig 文件时,所有这些更改都会被丢弃。

最后修改日期: 2025年 12月 8日代码样式和格式化EditorConfig