dangling_library_doc_comments
将库文档注释附加到库指令。
详情
#将库文档注释(使用 ///
)附加到库指令,而不是将它们悬空放置在库的顶部附近。
错误示例
dart
/// This is a great library.
import 'package:math';
dart
/// This is a great library.
class C {}
正确示例
dart
/// 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
analysis_options.yaml
yaml
linter:
rules:
- dangling_library_doc_comments
如果你改为使用 YAML 映射语法来配置 linter 规则,请在 linter > rules 下添加 dangling_library_doc_comments: true
analysis_options.yaml
yaml
linter:
rules:
dangling_library_doc_comments: true
除非另有说明,否则本网站上的文档反映的是 Dart 3.7.1 版本。页面上次更新于 2025-03-07。 查看源代码 或 报告问题。