使用godoc

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

安装

godoc默认位于go的安装包中，与go命令位于同一个目录中，安装了go以后就可以直接使用。

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

使用

运行下面的命令，即可启动一个可以在本地访问的godoc网站：

$ godoc -http=:6060

用浏览器打开http://127.0.0.1:6060/，就可以看到一个运行在本地的godoc站点。

本书中引用godoc连接的时候，默认链接到运行在本地的godoc。

浏览

这个运行在本地的godoc站点的内容与go的主页golang.org中的内容相同，主要由五部分组成；

Documents
Packages
The Project
Help
Blog

Documents中包含的信息最全，需要仔细阅读。例如Command Documentation、The Go Programming Language Specification。

特别是The Go Programming Language Specification，它对go语言语法的说明是最细致精确、最权威的。

Packages是go语言的package文档。

Project介绍了go语言项目。

Help给出寻求帮助的途径。

Blog是go项目的博客，介绍了go的发展、新特性，以及每个版本的性能情况等内容。

参考

  1. godoc
  2. golang.org
  3. go Documents
  4. go Command Documentation
  5. The Go Programming Language Specification
  6. go Packages
  7. go Project
  8. go Help
  9. go Blog

results matching ""

    No results matching ""