美文网首页
使用godoc创建本地Golang文档站点

使用godoc创建本地Golang文档站点

作者: Avery_up | 来源:发表于2019-10-25 14:22 被阅读0次

Golang官网地址为:https://golang.org/ ,由于某个原因,国内访问较慢或无法访问。所以在本地搭建文档站点很有必要。本文默认已安装go

查看go安装位置

> go env
...
GOARCH="amd64"
GOPATH="/Users/Ava/gopath"
GOROOT="/usr/local/go"
GOTMPDIR=""
...

使用 go env 命令查go安装目录GOROOT="/usr/local/go"

godoc启动站点

// 1. 进入bin目录 ( 或 cd /usr/local/go/bin )
> cd $GOROOT/bin

// 2. 查看 godoc 命令参数
> ./godoc --help
...
usage: godoc -http=localhost:6060
  -analysis string
        comma-separated list of analyses to perform (supported: type, pointer). See http://golang.org/lib/godoc/analysis/help.html
  -goroot string
        Go root directory (default "/usr/local/go")
  -http string
        HTTP service address (default "localhost:6060")
 ... 

// 3. 启动站点( 或 ./godoc -http=localhost:6060 )
> ./godoc -http=:6060

通过网页访问站点

打开网页,浏览 http://localhost:6060/

终端快速查看包文档、包内方法

> go doc packageName
> go doc packageName funcName

相关文章

网友评论

      本文标题:使用godoc创建本地Golang文档站点

      本文链接:https://www.haomeiwen.com/subject/knpsvctx.html