跳至主要內容

prefer_asserts_with_message

穩定

建議在 assert 中加入訊息。

詳細資訊

#

當 assertion 失敗時,不一定容易理解原因。在 assert 中加入訊息有助於開發人員理解為何發生 AssertionError。

不良範例

dart
f(a) {
  assert(a != null);
}

class A {
  A(a) : assert(a != null);
}

良好範例

dart
f(a) {
  assert(a != null, 'a must not be null');
}

class A {
  A(a) : assert(a != null, 'a must not be null');
}

啟用

#

若要啟用 prefer_asserts_with_message 規則,請在您的 analysis_options.yaml 檔案中,於 linter > rules 下方加入 prefer_asserts_with_message

analysis_options.yaml
yaml
linter:
  rules:
    - prefer_asserts_with_message

如果您改用 YAML map 語法來設定 linter 規則,請在 linter > rules 下方加入 prefer_asserts_with_message: true

analysis_options.yaml
yaml
linter:
  rules:
    prefer_asserts_with_message: true