跳到主內容

程式碼格式化

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