跳到主內容

程式碼格式化

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 文件。