使用godoc创建可以本地浏览的go文档站点

版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/cnwyt/article/details/84899801

Golang 的官网地址是golang.org，有的时候国内打不开。

现在国内的可以使用（golang.google.cn）。

其实，如果已经安装好了 go，可以在本地直接查看go 文档的。

直接查看go文档

go 的文档在 go 的安装目录中，即 /usr/local/go/doc。通过文本编辑器或浏览器直接打开即可查看。

通过 godoc 命令查看

godoc是go的一个命令，提供了可以在本地浏览的go文档。

godoc默认位于go的安装包中，与go命令位于同一个目录中。

go 的安装目录下/usr/local/go/

$ ll /usr/local/go/bin 
total 62496
-rwxr-xr-x  1 root  wheel    12M 11  3 05:02 go
-rwxr-xr-x  1 root  wheel    15M 11  3 05:11 godoc
-rwxr-xr-x  1 root  wheel   3.2M 11  3 05:02 gofmt

通过 godoc 包名 就可以查看包的信息了。
比如查看 fmt 就是直接在命令行输入:

$ godoc fmt

通过godoc生成文档站点

使用 --help 参数查看命令的用法：

$ godoc --help
usage: godoc package [name ...]
	godoc -http=:6060
...

运行文档站点，端口为6060:

$ godoc -http=:6060

使用 -http= 参数指定运行的端口号，注意端口号前有个冒号(:).

用浏览器打开http://localhost:6060/，就可以看到运行在本地的godoc网站了。

[END]