天天看點

vscode自動格式化代碼_代碼格式化

vscode自動格式化代碼_代碼格式化

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

  • 團隊使用單一,共享的代碼樣式。
  • 通過自動格式化代碼來保證統一的代碼樣式。

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

1. 在 Android Studio / IntelliJ 中自動格式化代碼

在 Android Studio / IntelliJ 中安裝 

Dart

 插件(見章節 編輯工具設定)來進行代碼的自動格式化。

格式化目前視窗中代碼的方法是先在代碼視窗中單擊右鍵,然後選擇 

Reformat Code with dartfmt

 選項即可。也可以在 IntelliJ 的偏好設定裡的 Keymap 部分中增加快捷鍵,然後使用快捷鍵操作。

2. 在 VS Code 中自動格式化代碼

在 VS Code 中安裝 

Flutter

 擴充(見章節 編輯工具設定)來進行代碼的自動格式化。

格式化目前視窗中代碼的方法是先在代碼視窗中單擊右鍵,然後選擇 

Format Document

 選項即可。也可以在 VS Code 的偏好設定裡面增加快捷鍵,然後使用快捷鍵操作。

将 

editor.formatOnSave

 設定成 

true

,可以在儲存檔案的時候自動進行代碼格式化。

3. 使用 ‘flutter’ 指令自動格式化代碼

我們也可以在指令行界面(CLI)中使用 

flutter format

 指令,進行代碼的自動格式化。

vscode自動格式化代碼_代碼格式化

4. 末尾處添加逗号

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

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

vscode自動格式化代碼_代碼格式化

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

vscode自動格式化代碼_代碼格式化
vscode自動格式化代碼_代碼格式化