type_annotate_public_apis

类型注解公共 API。

此规则从 Dart 2.0 开始可用。

此规则有快速修复可用。

来自高效 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.6.0。页面上次更新时间为 2024-07-03。查看源代码或报告问题。