• 配置代码风格
    • 基础和定义
    • 为一个语言配置代码风格
    • 从其他语言复制代码风格设置
    • 应用框架特性预定义的编码标准
    • 使用EditorConfig为一个项目配置代码风格
  • 另请参阅:

    配置代码风格

    在这个页面中:

    • 基础和定义
    • 为一个语言配置代码风格
    • 从其他语言复制代码风格设置
    • 应用框架特性预定义的编码标准
    • 使用EditorConfig为一个项目配置代码风格

    基础和定义

    如果在一个公司中存在某种编码指南,当创建代码时必须遵循这些指南。PhpStorm帮助维护这些所需的代码风格。

    代码风格在项目级别全局级别定义。

    • 项目级别,设置是在项目方案下分组,是预定义的并且用粗体字标记。项目样式方案仅应用于当前项目。

      默认方案不能被改变!当做了任意修改,PhpStorm自动创建默认方案的副本。如果你想使用不同的项目级别的方案,选择目标方案并将复制它的设置到项目。

    • 全局级别,设置是在预定义默认方案下分组,和任意用户创建的方案。全局设置被使用当用户不想保持项目的代码风格设置并想分享它们。

    为一个语言配置代码风格

    1. 在设置中,点击Code Style,然后点击目标语言。
    2. 选择要被当做基础设置的代码风格方案来为选择的语言定制代码风格。
    3. 浏览选择的语言页面中的标签页,然后为它配置代码风格偏好。

    从其他语言复制代码风格设置

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

    1. 在设置中,点击Code Style,然后点击目标语言。
    2. 点击右上角的链接Set From。这个链接仅在这些语言中出现,当定义设置基于其他语言是可用的。
    3. 在出现的下拉列表,点击要复制到当前代码风格的语言:

      为一个语言配置代码风格

    应用框架特性预定义的编码标准

    对PHP文件,你可以应用框架特性预定义的编码标准。

    1. 在设置中,点击Code Style,然后点击目标语言。
    2. 点击链接Set From,选择Predefined,然后选择相关的预定义标准。

    使用EditorConfig为一个项目配置代码风格

    更多信息参考网页EditorConfig

    要使用EditorConfig为一个项目配置代码风格:

    1. 在项目树,在想创建EditorConfig设置文件的目录右键单击,然后选择New | File
    2. 在打开的对话框,键入.editorconfig并点击OK

      PhpStorm创建EditorConfig设置文件并在弹出窗口显示一个通知

      每当你打开一个文件,EditorConfig插件在该开的文件的每个父目录中查找一个命名为.editorconfig的文件。查找.editorconfig的搜素将停止如果搜索到根目录或找到一个EditorConfig文件并且该文件中有root = true。因此,如果你想使用IDE设置而不是EditorConfig设置 ,在Editor | Code Style中清除Enable EditConfig Support复选框,该复选框默认是选中的。

    3. 开始定义你的代码风格设置 。保存(Ctrl+S)文件。每当你修改.editorconfig文件,保存文件来应用变更到项目中。

      EditorConfig代码风格配置重写IDE设置中的代码风格配置。

    另请参阅:

    规程:

    • 高级编辑规程

    参考:

    • 代码风格