跳至主要内容

代码格式化

虽然您的代码可能遵循任何首选样式,但根据我们的经验,开发人员团队可能会发现以下做法效率更高:

  • 拥有单一、共享的样式,以及
  • 通过自动格式化强制执行此样式。

另一种方法通常是令人疲惫的代码审查期间的格式化辩论,而将时间花在代码行为上而不是代码样式上可能会更好。

在 VS Code 中自动格式化代码

#

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

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

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

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

#

安装Dart插件(请参阅编辑器设置)以获取 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 [...]

使用尾随逗号

#

Flutter 代码通常涉及构建相当深层次的树形数据结构,例如在build方法中。为了获得良好的自动格式化效果,我们建议您采用可选的尾随逗号。添加尾随逗号的准则很简单:在您关心保持所创建格式的函数、方法和构造函数的参数列表末尾始终添加尾随逗号。这有助于自动格式化程序为 Flutter 风格的代码插入适当数量的换行符。

以下是用尾随逗号自动格式化的代码示例

Automatically formatted code with trailing commas

以及相同代码在不使用尾随逗号的情况下自动格式化的结果

Automatically formatted code without trailing commas