type_annotate_public_apis

为公共 API 添加类型注释。

此规则从 Dart 2.0 开始可用。

此规则提供了一个 快速修复。

来自 Effective Dart

**建议** 为公共 API 添加类型注释。

类型注释是关于如何使用库的重要文档。为公共方法和函数的参数和返回值添加类型注释，可以帮助用户了解 API 的预期输入和输出。

请注意，如果公共 API 接受 Dart 类型系统无法表达的一系列值，则可以不为其添加类型注释。在这种情况下，隐式 dynamic 是 API 的正确类型。

对于库内部的代码（私有代码或嵌套函数等），请根据需要添加类型注释，但不必强制提供。

错误示例

install(id, destination) {
  // ...
}

这里，id 的含义不清楚。是字符串吗？destination 又是什么？是字符串还是 File 对象？此方法是同步的还是异步的？

正确示例

Future<bool> install(PackageId id, String destination) {
  // ...
}

使用类型注释，所有这些都变得清晰了。

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

linter:
  rules:
    - type_annotate_public_apis

除非另有说明，否则本网站上的文档反映了 Dart 3.5.3。页面上次更新于 2024-07-03。 查看源代码 或 报告问题。