如何使用godoc获取文档

Question

在我的一个类中，我们必须使用godoc来记录Go代码。我们用于类的代码来自GitHub代码库，我们必须将其派生到我们的代码库。然后，我从我们的存储库中将其克隆到本地存储库。每次我尝试使用以下命令创建文档时

godoc -http=:6060 &

它不会更新。是不是因为它是从别人的repo中派生出来的？我相信它会记录本地的repo。

Answer 1

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

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

Answer 2

代码是否导出了任何函数？(公共函数名称以大写字母开头)

如果您的代码没有导出任何函数，您将看不到显示的文档，因为godoc的目的是显示可以被其他人使用的函数。