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。 檢視原始碼 或 回報問題。