使用 Gofmt 自動格式化 Go 程式語言原始碼

讓我們看看“gofmt”如何以一致的方式自動設定 Go 原始碼的樣式，以便更容易理解和管理。為了編寫可讀、可維護的程式碼，必須正確格式化程式碼。Go 原始碼可以使用“gofmt”命令列工具進行格式化。該程式使用一組規則和約定自動重新格式化 Go 程式碼，使其更易於閱讀和理解。

什麼是 Gofmt？

Gofmt 是一個命令列工具，用於一致地格式化 Go 原始碼。它會自動調整程式碼的空格、縮排和換行符，使其更易於理解和管理。Gofmt 工具是標準 Go 工具鏈的一部分，因此每個 Go 安裝程式中都包含它。

為什麼要使用 Gofmt？

使用“gofmt”格式化程式碼有以下幾個優點：

  • 一致的格式 − “Gofmt”強制對程式碼採用一致的樣式和格式，使其更易於閱讀和理解。

  • 更輕鬆的程式碼審查 − 一致的格式使程式碼審查更直接，因為審閱者可以專注於程式碼的邏輯和結構，而不是格式。

  • 節省時間 − 手動格式化程式碼可能非常耗時，尤其是在大型專案中。“gofmt”自動化了此過程，從而節省了時間。

如何使用 Gofmt

使用“gofmt”很簡單。開啟終端或命令提示符，並導航到包含 Go 原始碼的目錄。然後，執行以下命令：

gofmt -w .

此命令將重新格式化當前目錄及其子目錄中的所有 Go 原始碼檔案。

-w 標誌告訴“gofmt”將更改寫回到原始檔。如果省略此標誌，“gofmt”只會將重新格式化的程式碼列印到標準輸出。

如果要檢查程式碼是否符合 gofmt 的格式規則，而無需實際修改程式碼，可以使用以下命令：

gofmt -d .

此命令將顯示格式化後的程式碼和原始程式碼之間的差異，而不會更改原始檔。

自定義 Gofmt

如果喜歡與“gofmt”規則預設提供的格式不同的格式樣式，可以使用配置檔案修改工具的行為。配置檔案是一個 Go 原始檔，其中定義了一組程式碼格式化規則。然後，使用 -r 標誌執行 gofmt 以應用這些規則。

下面顯示了一個“gofmt”配置檔案示例：

// .gofmt.go
package main

import "golang.org/x/tools/imports"

func main() {
   // Customize the imports format
   imports.LocalPrefix = "github.com/myproject"

   // Customize the tab width
   imports.TabWidth = 4
}

要應用這些規則，請執行以下命令：

gofmt -r .gofmt.go

結論

編寫乾淨、可讀且可維護的 Go 程式碼需要使用“gofmt”。透過自動化程式碼的格式化，可以節省時間，提高一致性，並使程式碼更易於閱讀和理解。只需幾個簡單的命令，即可快速重新格式化 Go 程式碼，使其符合 Go 的常見格式標準或個人格式規則。

更新於：2023年4月6日

370 次瀏覽

啟動你的職業生涯

完成課程獲得認證

開始學習
廣告