在我的一个课程中,我们必须使用 godoc 来记录我们的 Go 代码。我们用于该类的代码来自一个 GitHub 存储库,我们必须将其分叉到我们的存储库中。然后从我们的仓库中,我将它克隆到本地仓库。每次我尝试使用创建文档时
godoc -http=:6060 &
它不会更新。是因为它是从其他人的回购中分叉的吗?我相信它会记录本地回购。
代码是否导出任何功能?(公共函数名称以大写字母开头)
如果您的代码没有导出任何函数,您将看不到显示的文档,因为 godoc 的想法是显示其他人可以使用的函数。
这个项目是一个 go 模块,你把它放在外面GOPATH
吗?如果是这样,那很可能您安装了旧版本godoc
,不支持 go 模块。
仅在最近才添加了对 godoc 的模块支持。您可以通过运行安装最新版本go get -u golang.org/x/tools/cmd/godoc
。然后,确保从(默认情况下它设置为)运行godoc
可执行文件。GOBIN
$GOROOT/bin