代码风格检查规则
使用 Dart 代码风格检查器识别 Dart 代码中可能存在的问题。您可以通过 IDE 或使用 dart analyze 命令使用代码风格检查器。有关如何启用和禁用单个代码风格检查规则的信息，请参阅 代码分析文档中的单个规则部分.
本页列出了所有代码风格检查规则，以及有关何时可能使用每个规则、哪些代码模式会触发它以及如何修复代码的详细信息。
集合
#为了避免需要单独选择兼容的代码风格检查规则，请考虑从代码风格检查规则集开始，以下包提供了代码风格检查规则集
- lints
- 包含由 Dart 团队精心策划的两个规则集。我们建议至少使用 *core* 规则集，该规则集在 对上传到 pub.dev 的包进行评分 时使用。或者，最好使用 *recommended* 规则集，它是 *core* 的超集，可以识别更多问题并强制执行样式和格式。如果您正在编写 Flutter 代码，请使用
flutter_lints包中的规则集，该规则集建立在 *lints* 之上。
- flutter_lints
- 包含 *flutter* 规则集，Flutter 团队鼓励您在 Flutter 应用程序、包和插件中使用此规则集。此规则集是
recommended集的超集，而recommended集本身又是core集的超集，而core集部分决定了上传到 pub.dev 的包的 评分.
要了解如何使用特定规则集，请访问 启用和禁用代码风格检查规则 的文档。
要查找更多预定义的规则集，请查看 pub.dev 上的 #lints 主题.
状态
#每个规则都具有一个状态或成熟度级别
- 稳定
- 这些规则可以安全使用，并且经过验证，可以与最新版本的 Dart 语言一起使用。所有规则都被认为是稳定的，除非它们被标记为实验性、已弃用或已删除。
- 实验性
- 这些规则仍在评估中，可能永远不会稳定。请谨慎使用这些规则，并报告您遇到的任何问题。
- 已弃用
- 这些规则不再建议使用，并且可能会在将来的 Dart 版本中删除。
- 已删除
- 这些规则已在最新的稳定 Dart 版本中删除。
快速修复
#某些规则可以使用快速修复自动修复。快速修复是对代码风格检查规则报告的问题进行的自动编辑。
如果规则具有快速修复，则可以使用 dart fix 或使用您的 支持 Dart 的编辑器 应用它。要了解更多信息，请参阅 代码分析问题的快速修复.
规则
#以下是所有代码风格检查规则的索引，以及对其功能的简要描述。要详细了解每个规则，请单击其名称。
要查看包含 Dart 3.5.3 中所有代码风格检查规则的自动生成列表，请查看 所有代码风格检查规则.
always_declare_return_types
声明方法返回值类型。
always_put_control_body_on_new_line
将控制结构表达式与语句分开。
always_put_required_named_parameters_first
将必需的命名参数放在首位。
always_require_non_null_named_parameters （已删除）
为没有默认值的命名参数指定 @required。
always_specify_types
指定类型注释。
always_use_package_imports
避免对 lib/ 中的文件使用相对导入。
annotate_overrides
对重写成员进行注释。
annotate_redeclares （实验性）
对重新声明的成员进行注释。
avoid_annotating_with_dynamic
避免在不需要时使用 dynamic 进行注释。
avoid_as （已删除）
避免使用 as。
avoid_bool_literals_in_conditional_expressions
避免在条件表达式中使用 bool 字面量。
avoid_catches_without_on_clauses
避免没有 on 子句的 catch 语句。
avoid_catching_errors
不要显式捕获 Error 或实现它的类型。
avoid_classes_with_only_static_members
避免定义只包含静态成员的类。
avoid_double_and_int_checks
避免 double 和 int 检查。
avoid_dynamic_calls
避免对 dynamic 目标进行方法调用或属性访问。
avoid_empty_else
避免在 else 子句中使用空语句。
avoid_equals_and_hash_code_on_mutable_classes
避免对未标记为 @immutable 的类重载运算符 == 和 hashCode。
avoid_escaping_inner_quotes
避免通过转换周围的引号来转义内部引号。
avoid_field_initializers_in_const_classes
避免在 const 类中使用字段初始化器。
avoid_final_parameters
避免对参数声明使用 final。
avoid_function_literals_in_foreach_calls
避免使用 forEach 和函数字面量。
avoid_futureor_void （未发布）
避免使用 'FutureOr
avoid_implementing_value_types
不要实现重写 == 的类。
avoid_init_to_null
不要显式将变量初始化为 null。
avoid_js_rounded_ints
避免 JavaScript 四舍五入的整数。
avoid_multiple_declarations_per_line
不要在一行上声明多个变量。
avoid_null_checks_in_equality_operators （已删除）
不要在自定义 == 运算符中检查 null。
avoid_positional_boolean_parameters
避免使用位置布尔参数。
avoid_print
避免在生产代码中使用 print 调用。
avoid_private_typedef_functions
避免使用私有类型定义函数。
avoid_redundant_argument_values
避免使用冗余的参数值。
avoid_relative_lib_imports
避免对 lib/ 中的文件使用相对导入。
avoid_renaming_method_parameters
不要重命名重写方法的参数。
avoid_return_types_on_setters
避免在 setter 上使用返回值类型。
avoid_returning_null （已删除）
避免从返回值类型为 bool、double、int 或 num 的成员中返回 null。
avoid_returning_null_for_future （已删除）
避免为 Future 返回 null。
avoid_returning_null_for_void
避免为 void 返回 null。
avoid_returning_this
避免从方法中返回 this，仅仅为了启用流畅的接口。
avoid_setters_without_getters
避免没有 getter 的 setter。
avoid_shadowing_type_parameters
避免隐藏类型参数。
avoid_single_cascade_in_expression_statements
避免在表达式语句中使用单级联。
avoid_slow_async_io
避免使用缓慢的异步dart:io方法。
avoid_type_to_string
避免
avoid_types_as_parameter_names
避免使用类型作为参数名称。
avoid_types_on_closure_parameters
避免为函数表达式参数添加类型注释。
avoid_unnecessary_containers
避免不必要的容器。
avoid_unstable_final_fields (已移除)
如果多次调用，避免重写最终字段以返回不同的值。
avoid_unused_constructor_parameters
避免在构造函数中定义未使用的参数。
avoid_void_async
避免返回void的async函数。
avoid_web_libraries_in_flutter
避免在 Flutter web 插件包之外使用仅限 web 的库。
await_only_futures
仅等待期货。
camel_case_extensions
使用 UpperCamelCase 命名扩展。
camel_case_types
使用 UpperCamelCase 命名类型。
cancel_subscriptions
取消dart:async StreamSubscription 的实例。
cascade_invocations
在同一引用上级联连续的方法调用。
cast_nullable_to_non_nullable
不要将可空值转换为非空类型。
close_sinks
关闭dart:core Sink 的实例。
collection_methods_unrelated_type
使用无关类型的参数调用各种集合方法。
combinators_ordering
按字母顺序排序组合器名称。
comment_references
在文档注释中仅引用作用域内的标识符。
conditional_uri_does_not_exist
缺少条件导入。
constant_identifier_names
建议使用 lowerCamelCase 命名常量。
control_flow_in_finally
避免在finally块中使用控制流。
curly_braces_in_flow_control_structures
对所有流程控制结构使用大括号。
dangling_library_doc_comments
将库文档注释附加到库指令。
depend_on_referenced_packages
依赖于引用的包。
deprecated_consistency
缺少已弃用注释。
deprecated_member_use_from_same_package
避免使用声明它们的包中的已弃用元素。
diagnostic_describe_all_properties
在调试方法中引用所有公共属性。
directives_ordering
遵守 Effective Dart Guide 指南中的指令排序约定。
discarded_futures
不要在非async块中调用异步函数。
do_not_use_environment
不要使用声明的环境变量。
document_ignores
记录忽略注释。
empty_catches
避免空 catch 块。
empty_constructor_bodies
对于空构造函数体，使用;代替{}。
empty_statements
避免空语句。
enable_null_safety (已移除)
使用健全的空安全。
eol_at_end_of_file
在文件末尾添加一个换行符。
exhaustive_cases
为类似枚举的类中的所有常量定义 case 子句。
file_names
使用lowercase_with_underscores 命名源文件。
flutter_style_todos
使用 Flutter TODO 格式：// TODO(username): message, https://URL-to-issue.
hash_and_equals
如果重写了==，始终重写hashCode。
implementation_imports
不要从另一个包中导入实现文件。
implicit_call_tearoffs
在将对象用作函数时，显式地撕下call方法。
implicit_reopen (实验性)
不要隐式地重新打开类。
invalid_case_patterns (实验性)
使用在 Dart 3.0 中有效的 case 表达式。
invalid_runtime_check_with_js_interop_types
避免使用 JS 交互类型的运行时类型测试，因为结果可能不一致。
invariant_booleans (已移除)
条件不应无条件地评估为true或false。
iterable_contains_unrelated_type (已移除)
使用无关类型的引用调用Iterable<E>.contains。
join_return_with_assignment
尽可能将 return 语句与赋值结合在一起。
leading_newlines_in_multiline_strings
以换行符开始多行字符串。
library_annotations
将库注释附加到库指令。
library_names
使用lowercase_with_underscores 命名库。
library_prefixes
在指定库前缀时，使用lowercase_with_underscores。
library_private_types_in_public_api
避免在公共 API 中使用私有类型。
lines_longer_than_80_chars
避免超过 80 个字符的代码行。
list_remove_unrelated_type (已移除)
使用无关类型的引用调用remove。
literal_only_boolean_expressions
仅由字面量组成的布尔表达式。
matching_super_parameters
使用匹配的超参数名称。
missing_code_block_language_in_doc_comment
代码块缺少指定的语言。
missing_whitespace_between_adjacent_strings
相邻字符串之间缺少空格。
no_adjacent_strings_in_list
不要在列表中使用相邻字符串。
no_default_cases (实验性)
没有默认情况。
no_duplicate_case_values
不要使用具有相同值的多个 case。
no_leading_underscores_for_library_prefixes
避免使用下划线作为库前缀。
no_leading_underscores_for_local_identifiers
避免使用下划线作为本地标识符。
no_literal_bool_comparisons
不要将布尔表达式与布尔字面量进行比较。
no_logic_in_create_state
不要在 createState 中放置任何逻辑。
no_runtimeType_toString
避免对runtimeType调用toString()。
no_self_assignments
不要将变量赋值给自己。
no_wildcard_variable_uses
不要使用通配符参数或变量。
non_constant_identifier_names
使用 lowerCamelCase 命名非常量标识符。
noop_primitive_operations
无操作基本操作。
null_check_on_nullable_type_parameter
不要对可能为空的类型参数使用null检查。
null_closures
不要将null作为闭包预期位置的参数传递。
omit_local_variable_types
省略本地变量的类型注释。
omit_obvious_local_variable_types (未发布)
省略本地变量的明显类型注释。
one_member_abstracts
当简单的函数就可以时，避免定义一个单成员抽象类。
only_throw_errors
只抛出继承自 Exception 或 Error 的类的实例。
overridden_fields
不要重写字段。
package_api_docs (已弃用)
为所有公共 API 提供文档注释。
package_names
对包名使用lowercase_with_underscores。
package_prefixed_library_names
使用包名和点分隔路径作为库名前缀。
parameter_assignments
不要重新分配对函数或方法参数的引用。
prefer_adjacent_string_concatenation
使用相邻字符串连接字符串字面量。
prefer_asserts_in_initializer_lists
建议将断言放在初始化列表中。
prefer_asserts_with_message
建议使用带有消息的断言。
prefer_bool_in_asserts (已移除)
建议使用布尔值作为断言条件。
prefer_collection_literals
尽可能使用集合字面量。
prefer_conditional_assignment
建议使用??=代替测试null。
prefer_const_constructors
建议对常量构造函数使用const。
prefer_const_constructors_in_immutables
建议在@immutable类上声明const构造函数。
prefer_const_declarations
建议对声明使用const而不是final。
prefer_const_literals_to_create_immutables
建议在@immutable类上使用 const 字面量作为构造函数的参数。
prefer_constructors_over_static_methods
建议定义构造函数而不是静态方法来创建实例。
prefer_contains
对List和String实例使用 contains。
prefer_double_quotes
建议在不需要转义序列的情况下使用双引号。
prefer_equal_for_default_values (已移除)
使用=将命名参数与其默认值隔开。
prefer_expression_function_bodies
对主体为单个 return 语句的简短成员使用=>。
prefer_final_fields
私有字段可以是final。
prefer_final_in_for_each
如果引用未重新分配，建议在 for-each 循环变量中使用 final。
prefer_final_locals
如果变量未重新分配，建议对变量声明使用 final。
prefer_final_parameters
如果参数未重新分配，建议对参数声明使用 final。
prefer_for_elements_to_map_fromIterable
建议在从可迭代对象构建映射时使用for元素。
prefer_foreach
仅对所有元素应用函数，使用forEach。
prefer_function_declarations_over_variables
使用函数声明将函数绑定到名称。
prefer_generic_function_type_aliases
建议使用泛型函数类型别名。
prefer_if_elements_to_conditional_expressions
尽可能使用 if 元素代替条件表达式。
prefer_if_null_operators
建议使用??运算符。
prefer_initializing_formals
尽可能使用初始化形式参数。
prefer_inlined_adds
尽可能内联列表项声明。
prefer_int_literals
建议使用 int 字面量代替 double 字面量。
prefer_interpolation_to_compose_strings
使用插值来组合字符串和值。
prefer_is_empty
对Iterable和Map使用isEmpty。
prefer_is_not_empty
对Iterable和Map使用isNotEmpty。
prefer_is_not_operator
建议使用 is! 运算符。
prefer_iterable_whereType
建议对可迭代对象使用whereType。
prefer_mixin
建议使用 mixin。
prefer_null_aware_method_calls
建议使用null感知方法调用。
prefer_null_aware_operators
建议使用null感知运算符。
prefer_relative_imports
建议对lib/中的文件使用相对导入。
prefer_single_quotes
仅对包含单引号的字符串使用双引号。
prefer_spread_collections
尽可能使用扩展集合。
prefer_typing_uninitialized_variables
建议对未初始化的变量和字段进行类型标注。
prefer_void_to_null
不要使用 Null 类型，除非您确定不需要 void。
provide_deprecation_message
使用@Deprecated("message")提供弃用消息。
public_member_api_docs
记录所有公共成员。
recursive_getters
属性 getter 递归地返回自身。
require_trailing_commas
对所有参数列表和参数列表使用尾随逗号。
secure_pubspec_urls
在pubspec.yaml中使用安全 URL。
sized_box_for_whitespace SizedBox 用于空格。
sized_box_shrink_expand
使用 SizedBox shrink 和 expand 命名构造函数。
slash_for_doc_comments
建议对文档注释使用///。
sort_child_properties_last
在小部件实例创建中，将子属性排序在最后。
sort_constructors_first
将构造函数声明排序在其他成员之前。
sort_pub_dependencies
按字母顺序排序发布依赖项。
sort_unnamed_constructors_first
将未命名的构造函数声明排序在最前面。
specify_nonobvious_local_variable_types (未发布)
指定本地变量的非明显类型注释。
super_goes_last (已移除)
将super调用放在构造函数初始化列表的最后。
test_types_in_equals
在operator ==(Object other)中测试参数的类型。
throw_in_finally
避免在finally块中使用throw。
tighten_type_of_initializing_formals
收紧初始化形式参数的类型。
type_annotate_public_apis
对公共 API 进行类型标注。
type_init_formals
不要为初始化形式参数添加类型注解。
type_literal_in_constant_pattern
不要在常量模式中使用类型字面量。
unawaited_futuresasync 函数体中的 Future 结果必须使用 await 等待，或者使用 dart:async 标记为 unawaited。
unintended_html_in_doc_comment
文档注释中的尖括号会被 Markdown 视为 HTML。
unnecessary_await_in_return
返回语句中不必要的 await 关键字。
unnecessary_brace_in_string_interps
避免在不需要的情况下在插值中使用花括号。
unnecessary_breaks
当隐含 break 时，不要使用显式的 break。
unnecessary_const
避免使用 const 关键字。
unnecessary_constructor_name
不必要的 .new 构造函数名称。
unnecessary_final
不要为局部变量使用 final。
unnecessary_getters_setters
避免仅仅为了“安全”而将字段包装在 getter 和 setter 中。
unnecessary_lambdas
当可以用撕裂时，不要创建 lambda。
unnecessary_late
当不需要时，不要指定 late 修饰符。
unnecessary_library_directive
避免库指令，除非它们有文档注释或注解。
unnecessary_library_name
在 library 声明中不要有库名称。
unnecessary_new
不必要的 new 关键字。
unnecessary_null_aware_assignments
避免在空感知赋值中使用 null。
unnecessary_null_aware_operator_on_extension_on_nullable
在可空类型上的扩展上使用不必要的空感知运算符。
unnecessary_null_checks (实验性)
不必要的 null 检查。
unnecessary_null_in_if_null_operators
避免在 ?? 运算符中使用 null。
unnecessary_nullable_for_final_variable_declarations
使用非空类型声明用非空值初始化的 final 变量。
unnecessary_overrides
不要重写方法来执行具有相同参数的 super 方法调用。
unnecessary_parenthesis
可以删除不必要的圆括号。
unnecessary_raw_strings
不必要的原始字符串。
unnecessary_statements
避免使用不必要的语句。
unnecessary_string_escapes
删除字符串中不必要的反斜杠。
unnecessary_string_interpolations
不必要的字符串插值。
unnecessary_this
不要使用 this 访问成员，除非避免阴影。
unnecessary_to_list_in_spreads
在扩展中不必要的 toList()。
unreachable_from_main
可执行库中无法从主函数访问的顶层成员。
unrelated_type_equality_checks
使用不相关类型的引用调用相等运算符 ==。
unsafe_html
避免使用不安全的 HTML API。
use_build_context_synchronously
不要在异步间隙中使用 BuildContext。
use_colored_box
使用 ColoredBox。
use_decorated_box
使用 DecoratedBox。
use_enums
使用枚举而不是像枚举一样工作的类。
use_full_hex_values_for_flutter_colors
使用 8 位十六进制整数（例如，0xFFFFFFFF）来实例化 Color。
use_function_type_syntax_for_parameters
使用泛型函数类型语法表示参数。
use_if_null_to_convert_nulls_to_bools
使用 ?? 运算符将 null 转换为 bool。
use_is_even_rather_than_modulo
使用 intValue.isOdd/isEven 而不是检查 % 2 的结果。
use_key_in_widget_constructors
在小部件构造函数中使用 key。
use_late_for_private_fields_and_variables (实验性)
使用 late 表示具有非空类型的私有成员。
use_named_constants
使用预定义的命名常量。
use_raw_strings
使用原始字符串来避免转义。
use_rethrow_when_possible
使用 rethrow 重新抛出捕获的异常。
use_setters_to_change_properties
使用 setter 来进行概念上更改属性的操作。
use_string_buffers
使用字符串缓冲区来组合字符串。
use_string_in_part_of_directives
在部分指令中使用字符串。
use_super_parameters (实验性)
尽可能使用 super 初始化程序参数。
use_test_throws_matchers
使用 throwsA 匹配器而不是 fail()。
use_to_and_as_if_applicable
如果适用，以 to/_to 或 as/_as 开头的方法名称。
use_truncating_division (未发布)
使用截断除法。
valid_regexps
使用有效的正则表达式语法。
void_checks
不要赋值给 void。
除非另有说明，本网站上的文档反映了 Dart 3.5.3。页面最后更新于 2024-08-07。 查看源代码 或 报告问题.