PyCharm 2025.2 Help

配置代码样式

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

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

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

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

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

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

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

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

配置方案

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

为某种语言配置代码样式

  1. 按下 Ctrl+Alt+S 打开设置，然后选择 编辑器｜代码样式。

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

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

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

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

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

从其他语言应用代码风格

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

  1. 按下 Ctrl+Alt+S 打开设置，然后选择 编辑器｜代码样式。

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

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

  3. 请选择您要修改的代码样式 方案： 项目 方案或 IDE 级别方案之一。

    设置代码样式

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

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

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

复制 code 样式设置

  1. 按下 Ctrl+Alt+S 打开设置，然后选择 编辑器｜代码样式。

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

  2. 选择要复制的代码样式 方案： 项目 方案或 IDE 级方案 之一。

  3. 请点击 显示方案操作 图标并选择以下选项之一：

    • 复制到IDE… （对于 项目 方案）：将选定的方案复制到 IDE 级别。

      PyCharm 将新代码样式以指定名称保存到 PyCharm 主目录。

    • 复制项目 （用于 IDE 级别方案）：用所选 IDE 级别配置文件中的设置覆盖您当前的项目设置。

    • 复制 （用于 IDE 级别方案）：在同一级别创建所选 IDE 方案的副本。

    复制代码样式方案设置

  4. 在 方案 字段中，键入新方案的名称，然后按 Enter 保存更改。

导入和导出方案

导入方案

开箱即用，PyCharm 允许您以 IntelliJ IDEA 代码样式 XML 格式导入设置。

  1. 按下 Ctrl+Alt+S 打开设置，然后选择 编辑器｜代码风格。

  2. 点击 "显示方案操作"按钮 并选择 导入方案。

  3. 在打开的对话框中，选择带有设置的文件并点击 打开。

  4. 如有必要，请重命名方案并选择 当前方案 以将方案的设置应用到您的代码中。

导出方案

您可以以 IntelliJ IDEA 代码样式 XML 或 EditorConfig 格式导出项目级别和 IDE 级别的方案（如果启用了 EditorConfig 插件）。

  1. 按下 Ctrl+Alt+S 以打开设置，然后选择 编辑器｜代码样式。

  2. 选择您要导出的代码样式 方案： 项目 方案或其中一种 IDE级别方案。

  3. 点击 "显示方案操作"按钮 ，选择 导出 ，选择所需的格式，并选择您要导出代码样式设置的目录。

使用 EditorConfig 在目录级别管理代码样式

PyCharm 允许您通过 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_<lang>_ 前缀开始，其中 <lang> 是语言域 ID（通常是小写语言名称），例如， ij_java_blank_lines_after_imports。

添加一个.editorconfig文件

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

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

  3. 要预览代码样式设置的更改将如何影响实际源文件，请点击 眼睛图标 ，位于 .editorconfig 文件的边距中，然后选择受其影响的源文件。 预览将在右侧打开。

    editorconfig 预览

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

最后修改日期： 2025年 9月 26日
语言和地区颜色和字体