【问题标题】:How to use godoc for documentation如何使用 godoc 做文档
【发布时间】:2020-07-01 23:11:41
【问题描述】:

在我的一个课程中,我们必须使用 godoc 来记录我们的 Go 代码。我们用于该类的代码来自一个 GitHub 存储库,我们必须将其分叉到我们的存储库中。然后从我们的仓库中,我将它克隆到本地仓库。每次我尝试使用

创建文档时
godoc -http=:6060 &

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

【问题讨论】:

  • 你杀掉之前的后台进程了吗?

标签: go document godoc


【解决方案1】:

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

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

【讨论】:

    【解决方案2】:

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

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

    【讨论】:

    • 使用sn-p代码以便读者更好地理解。
    • 如果您需要任何澄清或对问题的OP(Original Poster)有一些疑问,请在问题上添加评论。
    猜你喜欢
    • 2019-04-10
    • 2012-11-11
    • 2021-09-19
    • 2019-07-22
    • 2019-03-15
    • 2018-08-27
    • 2019-04-07
    • 2014-08-22
    • 1970-01-01
    相关资源
    最近更新 更多