library_private_types_in_public_api
避免在公開 API 中使用私有型別。
此規則自 Dart 2.14 起提供。
詳細資訊
#避免在公開 API 中使用函式庫私有型別。
就此程式碼檢查器而言,公開 API 會被視為任何頂層或成員宣告,除非該宣告為函式庫私有或包含在函式庫私有的宣告中。將檢查以下型別的使用方式
- 函式或方法的回傳型別、
- 函式或方法的任何參數的型別、
- 任何函式、方法、類別、混入、擴充的擴充型別或類型別名的類型參數的邊界、
- 任何頂層變數或欄位的型別、
- 類型別名宣告中使用的任何型別 (例如
typedef F = _Private Function();
),或 - 擴充或混入的
on
子句中使用的任何型別
不良
dart
f(_Private p) { ... }
class _Private {}
良好
dart
f(String s) { ... }
用法
#若要啟用 library_private_types_in_public_api
規則,請在您的 analysis_options.yaml
檔案的 linter > rules 下方新增 library_private_types_in_public_api
analysis_options.yaml
yaml
linter:
rules:
- library_private_types_in_public_api
除非另有說明,否則本網站的文件反映 Dart 3.6.0。頁面上次更新時間為 2024-07-03。檢視來源或回報問題。