内容

提供弃用消息

内容

通过 @Deprecated("message") 提供弃用消息。

此规则从 Dart 2.2 开始可用。

规则集：核心、推荐、Flutter

详情

#

请在 Deprecated 构造函数中指定弃用消息（包含迁移说明和/或移除计划）。

错误示例

dart
@deprecated
void oldFunction(arg1, arg2) {}

正确示例

dart
@Deprecated("""
[oldFunction] is being deprecated in favor of [newFunction] (with slightly
different parameters; see [newFunction] for more information). [oldFunction]
will be removed on or after the 4.0.0 release.
""")
void oldFunction(arg1, arg2) {}

用法

#

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

analysis_options.yaml
yaml
linter:
  rules:
    - provide_deprecation_message

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