程式碼格式化

每個人都有自己喜歡的程式碼樣式。但是根據我們的經驗,下面這些做法可以提高團隊的開發效率:

  • 團隊使用單一,共享的程式碼樣式。

  • 透過自動格式化程式碼來保證統一的程式碼樣式。

如果沒有統一的程式碼樣式,當進行程式碼審查的時候,可能會為了一些樣式的問題而進行爭論從而浪費時間。程式碼審查最好把時間花在程式碼的行為上,而不是程式碼的樣式上。

在 Android Studio / IntelliJ 中自動格式化程式碼

在 Android Studio / IntelliJ 中安裝 Dart 外掛(見章節 編輯工具設定) 來進行程式碼的自動格式化。在當前程式碼視窗中格式化程式碼的方法是,在 Windows 和 Linux 系統裡使用 Ctrl+Alt+L,在 Mac 系統裡使用 Cmd+Alt+L。 Android Studio 和 IntelliJ 為 Flutter 頁面提供了一個選項,即“在儲存的時候格式化程式碼”—— Format code on save,要開啟這個,可以在 Windows 和 Linux 下選擇設定、在 Mac 下選擇偏好設定。這樣在每次儲存程式碼的時候就會自動格式化當前檔案。

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

在 VS Code 中安裝 Flutter 擴充(見章節 編輯工具設定)來進行程式碼的自動格式化。

格式化當前視窗中程式碼的方法是先在程式碼視窗中單擊右鍵,然後選擇 Format Document 選項即可。也可以在 VS Code 的偏好設定裡面增加快捷鍵,然後使用快捷鍵操作。

editor.formatOnSave 設定成 true,可以在儲存檔案的時候自動進行程式碼格式化。

使用 ‘flutter’ 命令自動格式化程式碼

我們也可以在命令列介面(CLI)中使用 flutter format 命令,進行程式碼的自動格式化。

$ dart format path1 path2 ...

末尾處新增逗號

Flutter 程式碼經常會建構一定深度的樹形資料結構,如在 build 方法中。為了有更好的自動格式化效果,我們推薦在末尾處新增逗號,儘管也可以不這樣做。規則也比較簡單:總是在函式、普通方法、構造方法引數列表的末尾處新增逗號。這樣做會使格式化工具自動插入一些換行符,使程式碼更具有 Flutter 風格。

自動格式化的時候,末尾處 加入 逗號的例子:

末尾處有逗號進行程式碼自動格式化的情況 (Automatically formatted code with trailing commas)

同樣的程式碼在進行自動格式化的時候,末尾處沒有逗號的例子:

末尾處沒有逗號進行程式碼自動格式化的情況 (Automatically formatted code without trailing commas)