type_annotate_public_apis

為公開 API 加入類型註解。

此規則自 Dart 2.0 起可用。

此規則提供快速修正。

出自Effective Dart

偏好為公開 API 加入類型註解。

類型註解是關於函式庫應如何使用的重要文件。為公開方法和函式的參數及回傳類型加入註解，可協助使用者了解 API 期望什麼以及提供什麼。

請注意，如果公開 API 接受 Dart 類型系統無法表達的一系列值，則可以不加入類型。在這種情況下，隱含的 dynamic 是 API 的正確類型。

對於函式庫內部的程式碼（無論是私有的，還是像巢狀函式之類的東西），請在您認為有幫助的地方加入註解，但不要覺得您必須提供它們。

錯誤範例

install(id, destination) {
  // ...
}

在這裡，不清楚 id 是什麼。一個字串？而 destination 又是什麼？一個字串還是 File 物件？此方法是同步的還是非同步的？

正確範例

Future<bool> install(PackageId id, String destination) {
  // ...
}

有了類型，所有這些都變得明確了。

若要啟用 type_annotate_public_apis 規則，請在您的analysis_options.yaml檔案中的 linter > rules 下加入 type_annotate_public_apis

linter:
  rules:
    - type_annotate_public_apis

除非另有說明，否則本網站上的文件反映的是 Dart 3.6.0。頁面最後更新於 2024-07-03。 檢視原始碼 或回報問題。