如何在一些流行的回购中运行godoc?

时间:2014-06-25 16:04:21

标签: go documentation godoc

新的godoc有一些不错的功能,如来电者列表等。无论如何,我有运行它的问题,如:

➜  ~GOPATH git:(master) ✗ ls src/github.com/coreos/etcd/
CHANGELOG       DCO             Documentation   README.md       bench           build           contrib         error           fixtures        go_version.go   http            main.go         mod             scripts         store           tests
CONTRIBUTING.md Dockerfile      LICENSE         Vagrantfile     bin             config          discovery       etcd            foo             gopath          log             metrics         pkg             server          test.sh         third_party
➜  ~GOPATH git:(master) ✗ godoc github.com/coreos/etcd/discovery -http=:6060
No match found.

有没有人可以告诉我如何在像我这样使用的etd这样的热门回购网站上运行它?

3 个答案:

答案 0 :(得分:1)

Godoc有两个主要功能:

  1. 显示包
  2. 的文档
  3. 它运行一个网络服务器,您可以浏览以查看本地包文档
  4. 在这里,你试图同时做两件事。删除-http=:6060选项以查看控制台中的软件包文档,或删除软件包路径以运行Web服务器并在浏览器中进行搜索。

答案 1 :(得分:0)

Godoc可以在你的代码上运行文档来在终端上创建输出(运行没有-server或-http标志的godoc),或者可以作为带有-http / -server标记的服务器运行(并且不需要其他参数) 。不能同时兼得。

如果您没有在软件包中看到您的代码,那么您需要运行go install mypackage例如,如果您已克隆github.com/coreos/etcd/discovery,则运行go install github.com/coreos/etcd/discovery它应该显示在由godoc -http=:port

运行的go文档页面

我的代码遇到了这个问题,并没有看到任何其他答案。

答案 2 :(得分:0)

godoc -http=:6060 &
go get github.com/coreos/etcd/discovery
open http://localhost:6060/pkg/github.com/coreos/etcd/discovery