使用Gofmt自动格式化Go编程语言源代码

让我们看一下如何使用’gofmt’自动以一致的方式样式化您的Go源代码，以便更容易理解和管理。为了编写可读性强、易于维护的代码，必须正确格式化代码。可以使用’gofmt’命令行工具来格式化Go源代码。使用一组规则和约定，此程序会自动重新格式化您的Go代码，使其更容易阅读和理解。

什么是Gofmt？

一个名为Gofmt的命令行工具用于一致地格式化Go源代码。您的代码的空格、缩进和换行符将自动调整，使其更易于理解和管理。由于它是标准Go工具链的组成部分，因此每个Go安装都带有gofmt工具。

为什么要使用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的常规格式规范或您的个人格式规则。