go - 如何使用 godoc 做文档

Question

在我的一个类(class)中，我们必须使用 godoc 来记录我们的 Go 代码。我们用于该类的代码来自一个 GitHub 存储库，我们必须将其 fork 到我们的存储库中。然后从我们的仓库中，我将它克隆到本地仓库。每次我尝试使用创建文档时

godoc -http=:6060 &

它不会更新。是因为它是从其他人的 repo 中 fork 的吗？我相信它会记录本地 repo 。

Answer 1

这个项目是一个 go 模块，你把它放在 GOPATH 之外吗？ ?如果是这样，那很可能你有旧版本的 godoc已安装，不支持 go 模块。

Module support for godoc是最近才添加的。您可以通过运行 go get -u golang.org/x/tools/cmd/godoc 来安装最新版本.然后，确保运行 godoc可从 GOBIN 执行(默认设置为 $GOROOT/bin )。