内容

库_私有_类型_在_公共_api

避免在公共 API 中使用私有类型。

此规则从 Dart 2.14 开始可用。

规则集: 推荐flutter

详细信息

#

**避免**在公共 API 中使用库私有类型。

就这个代码风格检查而言,公共 API 被认为是任何顶层或成员声明,除非该声明是库私有的,或者包含在库私有的声明中。将检查以下类型的使用情况

  • 函数或方法的返回类型,
  • 函数或方法的任何参数的类型,
  • 任何函数、方法、类、混入、扩展的扩展类型或类型别名的类型参数的界限,
  • 任何顶层变量或字段的类型,
  • 在类型别名声明中使用的任何类型(例如 typedef F = _Private Function();),或者
  • 在扩展或混入的 on 子句中使用的任何类型

错误

dart
f(_Private p) { ... }
class _Private {}

正确

dart
f(String s) { ... }

用法

#

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

analysis_options.yaml
yaml
linter:
  rules:
    - library_private_types_in_public_api