Pycharm
 
2023.3
快捷方式：Windows
获取 PyCharm
  1. 配置 PyCharm
  2. 代码风格

配置代码风格

最后修改时间：2023 年 9 月 8 日

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

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

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

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

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

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

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

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

笔记

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

配置方案

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

配置语言的代码风格

  1. 按打开 IDE 设置，然后选择编辑器 | 代码风格。CtrlAlt0S

    要为新项目配置方案，请转到“文件”|“项目”。新项目设置 | 新项目的设置 | 编辑| 代码风格。

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

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

    提示

    单击“默认显示方案操作方案”旁边的并选择“复制”以创建该方案的副本。

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

    使用对话框的右侧部分预览更改。当您更改一项设置时，预览区域中会出现一个或多个闪烁区域，强调所做的更改。

应用另一种语言的代码风格

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

  1. 按打开 IDE 设置，然后选择编辑器 | 代码风格。CtrlAlt0S

    要为新项目配置方案，请转到“文件”|“项目”。新项目设置 | 新项目的设置 | 编辑| 代码风格。

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

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

  4. 单击右上角的“设置” 。

    仅当可以应用其他语言的代码样式设置时，才会显示该链接。

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

    笔记

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

    设置代码风格

复制代码样式设置

进出口方案

导入方案

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

  1. 按打开 IDE 设置，然后选择编辑器 | 代码风格。CtrlAlt0S

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

  3. 在打开的对话框中，选择具有设置的文件，然后单击“打开”。

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

导出方案

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

  1. 按打开 IDE 设置，然后选择编辑器 | 代码风格。CtrlAlt0S

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

  3. 单击显示方案操作按钮，选择导出，选择必要的格式，然后选择要将代码样式设置导出到的目录。

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

笔记

要使用 EditorConfig，请确保在设置中启用EditorConfig插件。按打开 IDE 设置，然后选择插件。单击“已安装”选项卡。在搜索字段中，输入EditorConfig。有关插件的更多信息，请参阅管理插件。CtrlAlt0S

PyCharm 允许您通过EditorConfig支持（默认在“设置”对话框 ( ) 中启用）管理每组文件的所有代码样式设置。您需要做的就是在根目录中放置一个.editorconfig文件，其中包含您要定义其代码样式的文件。您可以根据需要在项目中拥有任意多个.editorconfig文件，因此您可以为不同的模块指定不同的样式。CtrlAlt0S

.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.

笔记

相同的选项可以定义为通用选项和特定于语言的选项，例如ij_<...>_brace_style. 特定于语言的选项比通用或通用选项具有更高的优先级。

添加 .editorconfig 文件

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

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

  3. 要预览代码样式设置的更改将如何影响实际源文件，请单击.editorconfig眼睛图标文件的装订线并选择受其影响的源文件。预览将在右侧打开。

    编辑器配置预览

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

也可以看看

程序

参考