跳到主内容

代码格式化

Flutter 的代码格式化工具会按照推荐的风格指南格式化您的代码。

虽然您的代码可以遵循任何首选风格,但根据我们的经验,开发团队可能会发现以下方式更有效:

  • 拥有单一、共享的风格,并且
  • 通过自动格式化来强制执行此风格。

否则,代码审查期间经常会进行耗时的格式化讨论,而这段时间可能更适合用于讨论代码行为而不是代码风格。

在 VS Code 中自动格式化代码

#

安装 Flutter 扩展(请参阅 VS Code 设置)以在 VS Code 中获得代码的自动格式化。

要自动格式化当前源代码窗口中的代码,请在代码窗口中右键单击并选择 Format Document。您可以将键盘快捷键添加到 VS Code 首选项中。

要自动格式化每次保存文件时的代码,请将 editor.formatOnSave 设置为 true

在 Android Studio 和 IntelliJ 中自动格式化代码

#

安装 Dart 插件(请参阅 Android Studio 和 IntelliJ 设置)以在 Android Studio 和 IntelliJ 中获得代码的自动格式化。要格式化当前源代码窗口中的代码

  • 在 macOS 上,按 Cmd + Option + L
  • 在 Windows 和 Linux 上,按 Ctrl + Alt + L

Android Studio 和 IntelliJ 还在 首选项(macOS)或 设置(Windows 和 Linux)中的 Flutter 页面上提供一个名为 保存时格式化代码 的复选框。此选项会在您保存文件时更正当前文件中的格式。

使用 dart 命令自动格式化代码

#

要在命令行界面 (CLI) 中更正代码格式,请运行 dart format 命令

dart format path1 path2 [...]

要了解有关 Dart 格式化工具的更多信息,请查看 dart.dev 上的 dart format 文档。