dangling_library_doc_comments

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

将库文档注释 (使用 ///) 附加到库指令，而不是将其悬空在库文件的顶部附近。

不推荐 (BAD)

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

/// This is a great library.

class C {}

推荐 (GOOD)

/// 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

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

linter:
  rules:
    dangling_library_doc_comments: true