PyCharm 2025.3 Help

配置代码样式

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

该 IDE 随附两个预定义方案： 项目 方案和 默认 方案。

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

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

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

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

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

如果您希望将项目代码样式方案用作默认方案，可以将其复制到 IDE 级别。 反之亦然：您可以使用 IDE 级别方案中的设置覆盖当前项目设置，并与团队其他成员共享。

配置方案

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

为某种语言配置代码样式

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

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

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

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

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

    使用对话框右侧区域预览更改。 当您更改某个设置时，预览区域会出现一个或多个闪烁区域，以突出显示这些更改。

从其他语言应用代码样式

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

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

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

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

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

    设置代码样式

  4. 点击右上角的 设置来源。

    该链接仅在可以从其他语言应用代码样式设置时显示。

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

复制代码样式设置

  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. 如有必要，请重命名该方案，并选择 当前方案 以将该方案中的设置应用于您的代码。

导出方案

您可以将项目级别和 IDE 级别的方案导出为 IntelliJ IDEA 代码样式 XML 或 EditorConfig 格式（如果启用了 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年 12月 2日
语言和区域颜色与字体