跳到主内容

specify_nonobvious_property_types

实验性
有可用修复

为顶层变量和静态变量指定不明显的类型注解。

详情

#

当类型不明显时,为已初始化的顶层变量或静态变量添加类型注解。

顶层变量或静态变量上的类型注解可以作为类型推断的请求,记录类型推断步骤的预期结果,并声明性地允许编译器和分析器解决在初始化表达式中寻找类型参数和注解以产生所需结果的可能复杂的任务。

顶层变量或静态变量上的类型注解也可以告知读者初始化表达式的类型,这将使他们在代码中该变量被使用的地方继续阅读时,能够获得关于给定变量类型的已知良好信息(这些信息可能通过查看初始化表达式无法立即显而易见)。

当一个表达式没有明显的类型时,它被认为具有不明显的类型。

在以下情况下,表达式 e 具有明显的类型:

  • e 是非集合字面量。例如,1, true, 'Hello, $name!'。
  • e 是具有实际类型参数的集合字面量。例如,<int, bool>{}。
  • e 是列表字面量或集合字面量,其中至少一个元素具有明显的类型,并且所有元素具有相同的类型。例如,[1, 2] 和 { [true, false], [] },但不是 [1, 1.5]。
  • e 是映射字面量,其中所有键值对的键都具有明显的类型,值也具有明显的类型,并且所有键具有相同的类型,所有值也具有相同的类型。例如,{ #a[] },但不是 {1: 1, 2: true}。
  • e 是实例创建表达式,其类部分不是原始类型。例如,如果 C 是非泛型类,则 C(14);如果 C 接受一个类型参数,则 C(14);如果 C 接受一个或多个类型参数,则不是 C(14)。
  • e 是级联表达式,其目标具有明显的类型。例如,1..isEven..isEven 具有明显的类型,因为 1 具有明显的类型。
  • e 是类型转换。例如,myComplexExpression as int

反例

dart
final myTopLevelVariable =
    genericFunctionWrittenByOtherFolks(with, args);

class A {
  static var myStaticVariable =
      myTopLevelVariable.update('foo', null);
}

正例

dart
final Map<String, Widget?> myTopLevelVariable =
    genericFunctionWrittenByOtherFolks(with, args);

class A {
  static Map<String, Widget?> myStaticVariable =
      myTopLevelVariable.update('foo', null);
}

此规则为实验性规则。正在评估中,可能会更改或移除。欢迎提供有关其行为的反馈!主要问题在此:https://github.com/dart-lang/sdk/issues/59550。

启用

#

要启用 specify_nonobvious_property_types 规则,请在您的 analysis_options.yaml 文件中的 linter > rules 下添加 specify_nonobvious_property_types

analysis_options.yaml
yaml
linter:
  rules:
    - specify_nonobvious_property_types

如果您正在使用 YAML map 语法配置 linter 规则,请在 linter > rules 下添加 specify_nonobvious_property_types: true

analysis_options.yaml
yaml
linter:
  rules:
    specify_nonobvious_property_types: true