跳到主内容

代码格式化

Flutter 的代码格式化程序会按照推荐的样式指南格式化你的代码。

虽然你的代码可以采用任何首选样式,但根据我们的经验,开发团队如果能做到以下几点,工作效率会更高:

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

如果不这样做,往往会在代码审查期间引发令人疲惫的格式讨论,而这些时间本可以更好地用于关注代码行为而非代码样式。

在 VS Code 中自动格式化代码

#

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

要自动格式化当前源代码窗口中的代码,请在代码窗口中右键点击并选择 Format Document(格式化文档)。你可以在 VS Code 的 Preferences(首选项)中为此添加键盘快捷键。

若要在每次保存文件时自动格式化代码,请将 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 还在 Flutter 页面提供了一个名为 Format code on save(保存时格式化代码)的复选框,位置位于 macOS 的 Preferences(首选项)中或 Windows 和 Linux 的 Settings(设置)中。此选项会在你保存文件时更正当前文件中的格式。

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

#

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

dart format path1 path2 [...]

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