代码样式。 TypeScript

使用制表符

• 如果选中此复选框，将使用制表符：

  • 按下 Tab 键时

  • 对于缩进

  • 对于代码重排格式

• 如果取消勾选复选框，PhpStorm 将使用空格代替制表符。

智能制表符

一个缩进包含两部分。 一部分来自于嵌套代码块，另一部分由对齐确定。

• 如果选中此复选框，嵌套产生的部分将同时包含制表符和空格（如果有必要），而对齐定义的部分则仅由空格组成。

• 如果此复选框未选中，将只使用选项卡。 这意味着，在重新格式化后，适应指定制表符大小的一组空格将自动被替换为一个制表符，这可能导致微调对齐的破坏。

选项卡大小

在此字段中，指定一个制表符中能容纳的空格数。

缩进

在此字段中，指定为每个缩进级别插入的空格数量。

续行缩进

在此字段中，指定在数组元素、表达式、方法声明和方法调用之间插入的空格数量。

保持空行的缩进

如果选中此复选框，PhpStorm 会保留空行上的缩进，就像它们包含了一些代码一样。 如果取消选中该复选框，PhpStorm 将删除空行上的制表符和空格。

缩进链式方法

在函数的声明中，链中的第二个及更后续的方法会在单独的行中显示。

• 当选中复选框时，链中的第二个和更多的方法将与第一次调用对齐。

• 当取消选中复选框时，链中的第二个及后续方法将与调用它们的对象对齐。

缩进组中的所有链式调用

当选中此复选框时，首个和后续调用的方法将被缩进。

仅当选中 缩进链式方法 复选框时，此复选框才可用。

强制换行位置

在此字段中，指定元素右侧所需的空格数量。 如果您接受 默认 选项，则会使用 全局设置中的值。

键入时换行

在此字段中，指定编辑过的文本如何适应指定的 强制换行位置 字段。

• 默认 ：选择此选项以使用 键入时换行 值， 该值来自 全局设置。

• 是 ：选择此选项以使用 右边距 字段中的值。

• 否 ：如果您选择此选项，一行可以超过右边距中指定的值。

视觉指南

在此字段中，指定多个右边距。 您可以保留默认值，或者输入您的边距所需的空格数。 如果您想要指定多个边距，请输入由顿号分隔的数字。

在重新格式化时保持

在重新格式化源代码时，使用复选框来配置 PhpStorm 将要做出的异常。 例如，默认情况下， 换行符 复选框被选中。

如果您的代码包含的行长度短于标准规定，您可以通过在重新格式化之前取消勾选 换行符 复选框来进行转换。

包装选项

换行样式适用于左侧窗格中指定的各种代码结构（例如，方法调用参数或赋值语句）。

• 不要换行 - 当选中此选项时，不会应用任何特殊的换行样式，嵌套对齐和大括号设定将被忽略。

• 如果太长则进行换行 - 选择此选项可使用适当的缩进来换行超出右边距的行。

• 始终换行 - 选择此选项以将列表中的所有元素进行换行处理，使每行有一个元素，并具有适当的缩进。

• 如果太长就砍掉 - 选择此选项可将超出右边距的列表中的元素进行包装，以便每行有一个元素并且缩进适当。

对齐选项

• 多行时对齐 - 如果选中此复选框，代码结构将从每个下一行的同一列开始。 否则，代码结构的位置由当前的缩进级别确定。

• <character(s)> 在下一行 - 选中此复选框，当行换行时，将指定的字符或字符移至下一行。

• 'else' 在新的一行 - 使用此复选框将相应的声明或字符移动到下一行。

• 在 <字符> 后换行 - 选中此复选框以将指定字符后的代码移至新行。

• 特殊的 else if 处理 - 如果选中此复选框， else if 语句将位于同一行。

  否则， else if 语句将移动到下一行的相应缩进级别。

• 缩进 case 分支 - 如果选中此复选框， case 语句将位于相应的缩进级别。 否则， case 语句应与 switch 放置在相同的缩进级别。

• 对象 - 从列表中选择如何对齐对象：

  • 不要对齐 ：顺序行中的属性将不会对齐。

  • 关于冒号 ：顺序行中的属性将根据冒号对齐。

  • 关于 value ：顺序行中的属性将与值对齐。

• 变量声明 - 选择以下选项之一来配置等号的对齐方式：

  • 不要对齐 ：等号没有对齐。

  • 多行时对齐 ：在多行 var 语句中，通过插入额外的空格来对齐等号。

  • 分组时对齐 ：在多个 var 语句中，通过插入额外的空白，使得等号对齐。

• ES6 import/export 当选择 对齐 'from' 子句： 复选框时，PhpStorm 会自动对齐 import 和 export 语句，在 ECMAScript 6 代码中，使您的代码更易于阅读和维护。 比较带对齐和不带对齐的代码片段在 预览 面板中的显示差异。

  

  开启此选项后，PhpStorm将实时对新代码进行对齐。 现有 import 和 export 语句将在您按下 重新格式化代码后对齐 Ctrl+Alt+L。

大括号放置选项

保持最大空白行数量

在此区域中，指定在重新格式化后要保留的额外空行的数量。

最小空白行数

在此区域中，配置是否在 import 语句的块后以及类、字段、方法或函数周围有额外的空行。 在每个选项旁边的字段中，指定要留下的额外空白行的最小数量。

使用分号来终止语句

• Use 用分号来终止语句 在新代码中

• Use 用分号来终止语句 始终

• 不要使用 用分号来终止语句 在新代码中

• 不要使用 用分号来终止语句 始终

引号

• 使用 double 引号 在新代码中

• 使用 double 引号 始终

• 使用 单引号 引号 在新代码中

• 使用 单引号 引号 始终

尾随逗号

使用此列表配置您是否希望在对象、数组以及方法定义和调用的参数中使用 尾逗号。 可用选项包括：

• 保留

• 移除

• 添加时换行

使用 'public' 修饰符

选中此复选框以在生成的代码中插入或省略 public 访问修饰符。

例如，在从以下内容生成 public 方法时：

• 如果选中复选框， public 访问修饰符会自动插入到生成的代码中：

  class Test { public test():void { this.extracted(); } public extracted() { var x = 1; } }

• 如果清除复选框， public 访问修饰符将在代码生成过程中被省略：

  class Test { public test():void { this.extracted(); } extracted() { var x = 1; } }

请参阅 TypeScript Language Handbook ，第 Private/Public Modifiers 章。

命名规则

在这个区域：

• 配置或接受将自动添加到生成字段和属性名称的默认前缀。

• 选择生成文件名称的样式。 例如，当 PhpStorm 建议将一个类移动到一个新的自动生成的文件时，该文件的建议名称是根据所选风格从类名生成的。 从 保持类名和包含文件名的一致性 中学习更多信息。

注释代码

在此区域，配置生成注释的代码样式。

• 在 JSDoc 中包含类型 ：选中此复选框以自动为 @param、 @return 和其他标签添加类型。 请注意，类型信息对于 TypeScript 来说是多余的，因为类型是从代码本身中检索的。 因此，默认情况下复选框是清除的。

• 行注释在第一列 ：选中此复选框，以在第一列开始行评论。 当复选框未选中时，代码中的行注释将会对齐。

• 在行注释开始处添加空格 ：当选中此复选框时，将在行注释字符和被注释行的第一个字符之间插入一个空格。

  

  

• 在块注释周围添加空格 ：勾选此复选框以在块注释中添加前导和尾随空格。

  默认情况下，当您在块注释中封闭一个代码片段时，文本会在打开 /* 字符后立即开始，没有任何空格。 在关闭 */ 字符前都没有插入空格。 这种默认的代码样式可能与一些代码检查工具的规则发生冲突，例如，ESLint。

  

  

将来自同一模块的成员的导入合并

• 当选中此复选框时，来自同一模块的导入符号将在一个带有逗号作为分隔符的 import 语句中列出。 成员是按照他们被导入的顺序进行列出的。 要按字母顺序排列它们，选择 对导入的成员进行排序 复选框并运行 代码 | 优化导入。

• 当此复选框未选中时，每个导入的符号都会生成一个单独的 import 语句。

使用相对于tsconfig.json 的路径

选中此复选框时，PhpStorm 使用 tsconfig.json 文件作为根目录计算导入路径。 清除此复选框时，PhpStorm 相对于项目根目录计算导入路径。

例如，如果您的项目结构如下：

选中复选框时，PhpStorm 生成以下导入语句：

清除复选框时，生成以下导入语句：

当 index.js 可用时，使用目录导入（Node 风格模块解析）

假设您有一个具有以下结构的项目：

• 清除此复选框时，例如，文件 src/lib/index.js 将被导入为 ./src/lib/index.js。

• 选中复选框时，文件 src/lib/index.js 将被导入为 ./src/lib。

从 TypeScript 官方网站 了解更多关于 TypeScript 模块解析的信息。

使用文件扩展名

在此字段中，配置导入语句中的文件扩展名。

• 自动 - 使用此选项后，PhpStorm 总是会在以下文件的名称中添加扩展名：

  • .vue 文件。

  • 具有 .mts 扩展名的文件。

  • 项目中具有 "type":"module" 的文件位于 package.json 中，并且在 "module":"node16" 或 "module":"nodenext" 中具有 tsconfig.json 。

• 总是 .js - 使用此选项，PhpStorm 会自动在 import 语句中的文件名添加扩展名。 当您在需要完整文件名的浏览器中使用 ES6 模块时（例如，在 Chrome 中），这一点非常重要。 PhpStorm 在自动生成导入声明、进行代码补全，或者当您使用 Alt+Enter 调用导入生成时，均会应用此设置。

• Never - 使用此选项，PhpStorm 在生成导入语句时始终插入不带扩展名的文件名。

在导入中使用类型修饰符

在此字段中，配置在类型的导入语句中使用 type 修饰符。 请注意，设置仅适用于类型，对于非类型，无论您选择哪个选项，都不会插入 type 修饰符。

启用此选项后，如果在您的 tsconfig.json 中指定了 "importsNotUsedAsValues": "error" 或 "verbatimModuleSyntax": true ，则会添加一个 type 修饰符。

否则，如果没有首选的导入类型，则不会插入 type 修饰符。

使用此选项时，无论在您的 tsconfig .json 中是否指定 "importsNotUsedAsValues": "error" 或 "verbatimModuleSyntax": true ，始终会插入 type 修饰符：

使用此选项，PhpStorm 永远不会使用 type 修饰符，而不论 "importsNotUsedAsValues": "error" 或 "verbatimModuleSyntax": true 标志在您的 tsconfig.json 中:

使用来自 tsconfig.json 的路径映射

在此字段中，配置 import 语句中路径的样式。

• 始终 - 使用此选项时，PhpStorm 始终使用来自您的 tsconfig.json 的 路径映射。

• 从不 - 使用此选项，PhpStorm始终在生成的导入中使用相对路径。

• 仅在指定路径以外的文件中 - 使用此选项时，PhpStorm 在为定义了相同路径映射的文件之间生成导入时使用相对路径。 在所有其他文件中，将使用路径映射。

在下面的示例中，文件 animal.ts 和 bird.ts 存储在 动画 文件夹下的文件夹中，该文件夹在 tsconfig.json 中指定了路径映射。 文件 dog.ts 不在路径映射范围内。

路径映射 @Lib 配置如下：

因此，每个 始终 和 Never 选项都以相同的方式应用于 bird.ts 和 dog.ts 。 选择 仅在指定路径外的文件中 选项时，PhpStorm 生成不同样式的 import 语句：在 bird.ts 中使用相对路径，在 dog.ts 中使用路径映射。

导入语句使用 @Lib 路径映射。

导入声明使用相对路径。

PhpStorm 生成不同样式的 import 语句：在 bird.ts 中使用相对路径，在 dog.ts 中使用 @Lib 路径映射。

不从指定路径或路径模式导入

在此字段中，指定 PhpStorm 在自动导入符号期间应跳过的确切路径。 相反，PhpStorm 将寻找导入符号的其他路径。

这对于允许导入其子模块而不是整个模块的模块特别有用。 例如，若要优先考虑像 import {Observable} from 'rxjs/Observable' 这样的导入，而不是更通用的 import {Observable} from 'rxjs' ，请将 rxjs 添加到列表中。

要管理要跳过的模块列表：

1. 点击字段右侧的 。

2. 在打开的 更改模块 对话框中，点击 并在 添加模块 对话框中指定模块名称。 要从列表中移除一个模块，选择它并点击 。

对导入的成员进行排序

• 当选中此复选框时，PhpStorm 将在合并的 import 语句中按字母顺序列出导入的成员。 请注意，成员是按照导入的顺序列出的，只有在您运行 代码 | 优化导入 时才会重新排序。

• 当此复选框未选中时，合并的 import 语句中的成员总是按照它们被导入的顺序以逗号分隔的形式列出。

按模块排序导入

• 当选中此复选框时，运行 代码 | 优化导入 时， import 语句会按模块名称按字母顺序重新排序。

• 当此复选框未选中时， import 声明总是按照生成的顺序显示，并且在您运行 代码 | 优化导入 后，该顺序不会改变。

分组规则

使用此区域来设置分组规则。

• 保持重写方法在一起

  选择此复选框以按类和接口将重写的方法分组。 在 订单 列表中，选择 保持排序 或 按名称排序 选项。

匹配规则

在此区域定义元素顺序，这是一组规则的列表，每个规则有一组匹配项，如修饰符或类型。

• ：使用此按钮来添加规则。 空规则 区域已打开。

• ：使用此按钮从列表中移除规则。

• ：使用此按钮编辑现有规则。 要查看此按钮，请导航至您想要编辑的规则并点击按钮。 在弹出的窗口中，修改规则字段。

• ：使用这些按钮将选定的规则上移或下移。

空规则

使用这个区域创建新的匹配规则，或编辑已有的规则。 您可以从以下筛选器中选择：

• Type ：使用此筛选器为您的规则选择构造函数、方法或属性。

  请注意，双击类型关键字将否定条件。

• 修饰符 ：使用此过滤器来选择规则的修饰符类型。

  请注意，点击两次修饰符关键字会否定该条件。

• 名称 ：使用此字段来在规则中指定条目名称。 此筛选器仅匹配条目名称，例如字段名称、方法名称、类名称等。 该过滤器支持正则表达式，并使用 标准语法。 匹配是针对整个名称进行的。

• 订单 ：使用此列表来选择规则的排序顺序。 当多个元素使用相同的匹配规则时，此选项非常有用。 在这种情况下，选择 保持顺序 将保持在重排之前设置的相同顺序，选择 按名称排序 将按照它们的名称对相同匹配规则的元素进行排序。

• 别名 ：此选项显示在 规则别名定义 对话框中定义的别名。 您可以删除不需要的部分。

当您从 订单 列表中选择 Order by Name时，此图标会出现。 图标表示此规则中的项目按字母顺序排序。