代码格式设置指的是如何在文件中设置代码的格式,也就是如何缩进和回车,在go语言中没有强制的约定,但在整个社区广泛采用并遵循的事实标准。

代码格式设置风格是一个常常在程序员之间引起争论的主题,在大多数情况下,这些争论都让人专注于格式而不是代码。go语言指定了格式设置约定,这种约定虽然并非强制性的,但命令gofmt可以实现它。对于这种格式设置方面的默认选择,有些程序员最初很不满意,但实际上,在官方代码中做出这样的选择,对大家来说意味着不需要花时间去讨论风格的正确性。

gofmt命令的用法

gofmt abc.go

这样是把格式化后的结果打印到标准输出,但不修改原来的文件。

如果想修改文件,使用-w

gofmt -w abc.go

也可以使用文本编辑器校正格式设置,一般的文本编辑工具都有第三方的go插件。

golint是go语言提供的一个官方工具,根据go项目本身的约定查找风格方面的错误,默认不会安装go

golint,可以使用像下面的方法安装

go get -u github.com/golang/lint/golint

要检验是否安装成功,可在终端执行命令golint --help。如果正确安装了,可以在终端看到一个帮助信息。

使用方法

go lint abc.go

golint可能指出代码的行号和位置需要注意。


随着开发的程序越来越复杂,要确保其品质优良,编写文档也至关重要。即便您单独开发,注释也有助于您在以后能够快速理解代码。godoc是一款官方工具,可通过分析go语言源代码及其中的注释来生成文档。由于文档是根据源代码生成的,这很大程度上避免了文档不同步问题。

虽然godoc是官方工具,但还需要单独安装

go get golang.org/x/tools/cmd/godoc

要检验是否正确安装,在终端中执行命令godoc --help,如果正确安装了,可以在终端看到一个帮助信息。

使用方法

godoc ./fold