dangling_library_doc_comments

将库文档注释附加到库指令。

此规则自 Dart 2.19 起可用。

规则集：核心、推荐、flutter

此规则有一个可用的快速修复。

将库文档注释（使用///）附加到库指令，而不是将其悬挂在库的顶部附近。

错误

/// This is a great library.
import 'package:math';

/// This is a great library.

class C {}

正确

/// This is a great library.
library;

import 'package:math';

class C {}

注意：未命名的库，如上面的 library;，仅在 Dart 2.19 及更高版本中受支持。可能在早期 Dart 版本中运行的代码需要在 library 指令中提供名称。

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

linter:
  rules:
    - dangling_library_doc_comments

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