内容
description bug_report

代码格式化

内容

虽然你的代码可能遵循任何首选风格，但根据我们的经验，开发人员团队可能会发现

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

另一种方法是在代码审查期间进行经常令人疲惫的格式化争论，与其在代码风格上浪费时间，不如将时间花在代码行为上。

在 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