type_annotate_public_apis

為公開 API 新增類型註解。

出自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

如果您改為使用 YAML 對應語法來設定 linter 規則，請在 linter > rules 下方新增 type_annotate_public_apis: true

linter:
  rules:
    type_annotate_public_apis: true

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