golang学习系列——5. 常用工具

目录

 

编译代码

格式化工具

生成代码文档工具

其它工具

---

编译代码

从 Go 1 版本开始，使用 Go 自带的更加方便的工具来构建应用程序

• go build 编译自身包和依赖包
• go install 编译并安装自身包和依赖包

格式化工具

强制统一风格（手动滑稽）

Go 开发团队不想要 Go 语言像许多其它语言那样总是在为代码风格而引发无休止的争论，浪费大量宝贵的开发时间，因此他们制作了一个工具：go fmt（gofmt）。这个工具可以将你的源代码格式化成符合官方统一标准的风格，属于语法风格层面上的小型重构。遵循统一的代码风格是 Go 开发中无可撼动的铁律，因此你必须在编译或提交版本管理系统之前使用 gofmt 来格式化你的代码。

在大多数 IDE 中，每次构建程序之前都会自动调用源码格式化工具 gofmt 并保存格式化后的源文件。

命令行

格式化该源文件的代码然后将格式化后的代码覆盖原始内容
如果不加参数 -w 则只会打印格式化后的结果而不重写文件
gofmt –w program.go
格式化并重写所有 Go 源文件
gofmt -w *.go
格式化并重写目录及子目录下的所有 go 源文件
gofmt -w test

gofmt 也可以用参数 -r 后面来设置替换规则实现代码的简单重构，规则的格式：<原始内容> -> <替换内容>。

gofmt -r '(a) -> a' –w *.go
gofmt -r 'a[n:len(a)] -> a[n:]' –w *.go
gofmt –r 'A.Func1(a,b) -> A.Func2(b,a)' –w *.go

生成代码文档工具

go doc 工具会从 Go 程序和包文件中提取顶级声明的首行注释以及每个对象的相关注释，并生成相关文档。
它也可以作为一个提供在线文档浏览的 web 服务器，http://golang.org 就是通过这种形式实现的。

• go doc package 获取包的文档注释，例如：go doc fmt 会显示使用 godoc 生成的 fmt 包的文档注释。
• go doc package/subpackage 获取子包的文档注释，例如：go doc container/list。
• go doc package function 获取某个函数在某个包中的文档注释，例如：go doc fmt Printf 会显示有关 fmt.Printf() 的使用说明。

这个工具只能获取在 Go 安装目录下 ../go/src 中的注释内容。

其它工具

• go install 是安装 Go 包的工具，类似 Ruby 中的 rubygems。主要用于安装非标准库的包文件，将源代码编译成对象文件。
• go fix 用于将你的 Go 代码从旧的发行版迁移到最新的发行版，它主要负责简单的、重复的、枯燥无味的修改工作，如果像 API 等复杂的函数修改，工具则会给出文件名和代码行数的提示以便让开发人员快速定位并升级代码。Go 开发团队一般也使用这个工具升级 Go 内置工具以及 谷歌内部项目的代码。go fix 之所以能够正常工作是因为 Go 在标准库就提供生成抽象语法树和通过抽象语法树对代码进行还原的功能。该工具会尝试更新当前目录下的所有 Go 源文件，并在完成代码更新后在控制台输出相关的文件名称。
• go test 是一个轻量级的单元测试框架。