Skip to main content
Contents

代码格式化

Contents

虽然您的代码可能遵循任何首选的风格——根据我们的经验——开发团队可能会发现以下方法效率更高：

  • 采用单一的、共享的风格，以及
  • 通过自动格式化强制执行此风格。

另一种选择通常是在代码审查期间进行令人疲惫的格式化辩论，而这段时间最好花在代码行为上，而不是代码风格上。

在 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 风格的代码插入适当数量的换行符。

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

带有尾随逗号的自动格式化代码

以及相同代码的自动格式化代码，不带 尾随逗号：

不带尾随逗号的自动格式化代码

除非另有说明，否则本网站上的文档反映的是 Flutter 的最新稳定版本。页面最后更新于 2025-01-30。 查看源代码 或 报告问题。