GoLand 2025.2 Help

EditorConfig

GoLand 允许您使用 EditorConfig 支持为每个文件集合管理所有代码样式设置。

您只需将一个 .editorconfig 文件放置在包含要定义代码样式的文件的根目录中。 如果项目中有多个代码样式(例如用于测试和生产代码),则可以在项目相应的文件夹中放置多个 .editorconfig 文件。 这使您可以同时遵循多个代码样式标准。

.editorconfig 文件中的所有选项会在当前项目代码样式的基础上应用于其所在目录及其所有子目录。 如果在 .editorconfig 或位于父目录中的其他 .editorconfig 文件中未定义某些内容,则会从当前 代码样式方案 中获取。 有关未定义(unset )属性的更多信息,请参阅 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

所有 IntelliJ .editorconfig 属性在 代码样式方案 中都有对应的选项,并且名称类似。

添加 .editorconfig 文件

  1. 项目 工具窗口(Alt+1 )中,右键单击包含要定义代码样式的文件的源目录,然后从上下文菜单中选择 新建 | EditorConfig

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

  3. 要预览代码样式设置更改对实际源文件的影响,请单击 眼睛图标 文件边距中的 .editorconfig ,然后选择要预览更改的源文件。 预览将在右侧打开。

    请确保您选择的文件与单击 眼睛图标 所在的掩码相对应。

    您可以在预览窗格中进行更改,以测试配置更改的效果,而无需担心影响源代码:这些更改在关闭 .editorconfig 文件时将被放弃。

  4. 重新格式化代码。 您可以重新格式化 代码片段文件目录中的所有文件

    或者,您还可以配置 IDE 在保存时 重新格式化代码

要快速了解当前在编辑器中打开的文件是否有被 .editorconfig 文件中的属性覆盖的代码样式选项,请使用状态栏中的缩进小部件。

该小部件中的 图标表示存在一个 .editorconfig 文件覆盖了当前代码样式方案中的部分设置。

带有 EditorConfig 图标的缩进小部件

单击该小部件:

  • 单击 打开.editorconfig 打开影响当前正在编辑文件的最近的 .editorconfig 文件。

  • 选择 显示与项目相关的文件… 以打开项目中所有 .editorconfig 文件的列表。

  • 单击 对项目禁用 以在项目中禁用 EditorConfig 支持,并使用当前代码样式方案中的设置。 您也可以在设置中 禁用 EditorConfig 支持

从缩进小部件打开的 EditorConfig 菜单

将代码样式导出为 .editorconfig 文件

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

  2. 选择要导出的代码样式 方案项目 方案或某个 IDE 级别方案

  3. 单击 “显示方案操作”按钮 ,选择 导出 ,然后选择 EditorConfig 文件

    将代码样式设置导出为 .editorconfig 文件
  4. 指定要保存文件的文件夹。

要导入 .editorconfig 文件中的代码样式设置,请将文件拖动到 项目 工具窗口中的相应文件夹中 Alt+1视图 | 工具窗口 | 项目

禁用 EditorConfig 支持

如果在创建 .editorconfig 设置文件后决定使用 IDE 设置,您可以在不删除项目中已创建的 .editorconfig 文件的情况下禁用 EditorConfig 支持。

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

  2. 取消选中 启用EditorConfig 支持 复选框。

  3. 应用更改并关闭对话框。

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