type_annotate_public_apis

为公共 API 添加类型注解。

来自 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

如果您改为使用 YAML 映射语法来配置 linter 规则，请在 linter > rules 下添加 type_annotate_public_apis: true

linter:
  rules:
    type_annotate_public_apis: true

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