library_private_types_in_public_api
避免在公共 API 中使用私有类型。
详情
#避免在公共 API 中使用库私有类型。
对于此 lint 而言,公共 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
如果您改为使用 YAML 映射语法来配置 linter 规则,请在 linter > rules 下添加 library_private_types_in_public_api: true
analysis_options.yaml
yaml
linter:
rules:
library_private_types_in_public_api: true
除非另有说明,否则本网站上的文档反映的是 Dart 3.7.1 版本。页面上次更新于 2025-03-07。 查看源代码 或 报告问题。