跳至主要內容

程式碼格式化

雖然您的程式碼可以使用任何偏好的風格,但根據我們的經驗,開發團隊可能會發現以下方式更有效率:

  • 使用單一、共享的風格,並且
  • 透過自動格式化來強制執行此風格。

另一種替代方案通常是在程式碼審查期間進行令人疲憊的格式辯論,而時間本來可以更好地花在程式碼行為而不是程式碼風格上。

在 VS Code 中自動格式化程式碼

#

安裝 Flutter 擴充功能(請參閱編輯器設定)以在 VS Code 中自動格式化程式碼。

若要自動格式化目前原始碼視窗中的程式碼,請在程式碼視窗中按一下滑鼠右鍵,然後選取 Format Document。您可以將鍵盤快速鍵新增至此 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