unnecessary_library_name
不要在 library
声明中包含库名称。
此规则从 Dart 3.4 开始可用。
规则集:recommended,flutter
此规则具有可用的快速修复。
详情
#不要在 library
声明中包含库名称。
库名称不是必需的。
库不需要库声明,但可以添加一个声明来附加库文档和库元数据。声明 library;
足以用于这些用途。
库名称的唯一用途是让 part
文件引用其所属库,但 part 文件应首选使用字符串 URI 来引用库文件,而不是库名称。
如果在库声明中添加库名称,则会引入名称冲突的风险。如果同一程序中的两个库具有相同的库名称,则会发生编译时错误。为了避免这种情况,库名称往往很长,包括包名称和路径,只是为了避免意外的名称冲突。这使得这些库名称难以阅读,甚至无法用作文档。
错误
dart
/// This library has a long name.
library magnificator.src.helper.bananas;
dart
library utils; // Not as verbose, but risks conflicts.
正确
dart
/// This library is awesome.
library;
part "apart.dart"; // contains: `part of "good_library.dart";`
用法
#要启用 unnecessary_library_name
规则,请在 analysis_options.yaml
文件中的 linter > rules 下添加 unnecessary_library_name
analysis_options.yaml
yaml
linter:
rules:
- unnecessary_library_name
除非另有说明,否则本网站上的文档反映的是 Dart 3.6.0。页面最后更新于 2024-07-03。 查看源代码 或 报告问题。