如何使用godoc进行文档编制

如何使用godoc进行文档编制,go,document,godoc,Go,Document,Godoc,在我的一个类中,我们必须使用godoc来记录我们的Go代码。我们用于该类的代码来自一个GitHub repo,我们必须将它分叉到我们的repo。然后从我们的回购协议中,我将其克隆到本地回购协议中。每次我尝试使用 godoc -http=:6060 & 它不会更新。是因为它是从其他回购协议中分得的吗?我相信它会记录本地回购协议。这个项目是go模块吗,你把它放在了GOPATH之外?如果是这样,很可能您安装了不支持go模块的旧版本的godoc 是最近才添加的。您可以通过运行go-get-u

在我的一个类中,我们必须使用godoc来记录我们的Go代码。我们用于该类的代码来自一个GitHub repo,我们必须将它分叉到我们的repo。然后从我们的回购协议中,我将其克隆到本地回购协议中。每次我尝试使用

godoc -http=:6060 &

它不会更新。是因为它是从其他回购协议中分得的吗?我相信它会记录本地回购协议。

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


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

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


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

您是否取消了以前的后台进程?请使用一段代码,以便读者能够更好地理解。如果您需要任何澄清或有一些问题,请参阅(原始海报)的问题,添加对问题的评论。