程式碼格式化

雖然您的程式碼可以遵循任何偏好的樣式,但根據我們的經驗,開發人員團隊可能會發現

  • 擁有單一的共用樣式,以及
  • 透過自動格式化來強制執行此樣式。

替代方案通常是在程式碼檢閱期間進行繁瑣的格式化辯論,此時最好將時間花在程式碼行為而不是程式碼樣式上。

在 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