为整个项目生成godoc文档？

Question

我一直在与godoc搏斗，并发现“godoc”更多地用于从命令行提供使用帮助，例如：

go doc -cmd -u

列出包注释和任何函数(或其他实体)

go doc *function*

然后显示单个函数(或其他实体)的文档。

似乎有一个相关的工具叫做godoc。godoc似乎也根据每个包和函数生成html。例如。

godoc -html hello

生成只包含stdout的包注释的html。

godoc是一个非常令人困惑的名字，因为我们也要去文档！

如何为整个项目创建静态文档？

这类似于Godoc，为整个包创建html，它可能被误解为询问包而不是项目的文档。我想要一个构建步骤，我可以在一个项目中使用，原则上可能包含许多软件包和应用程序。

Answer 1

是否有一种规范的方法来生成文档供离线使用，甚至使用godoc？

Go 1.12 (2019年2月)更清楚地认识到这一点：

godoc和go doc 在Go 1.12中，godoc 不再具有命令行接口，而仅仅是一个web服务器.。 用户应该使用go doc作为命令行帮助输出。 标志，这将使它打印所有导出的API及其文档，就像godoc命令行所做的那样。 cmd/doc：添加-all标志以打印包的所有文档 与旧的godoc不同，您需要使用-u标志来查看未导出的符号。 这似乎是正确的行为:它是一致的。

Answer 2

我挣扎着去做这件事，最后，对我起作用的是

1. 确保安装了"wget“(我使用的是mac，所以必须使用x代码安装)。
2. 以root用户的身份登录，并修改名为"robots.txt“的文件，以删除”download : /“行，因为这样可以阻止wget递归下载站点。"robots.txt“文件应该位于$GOROOT路径中。
3. 打开cmd并使用以下命令启动godocs服务器 godoc -http=:6060 我已将本地路径配置为此端口。
4. 打开另一个cmd并运行以下命令。 wget -r -np -N -E -p -k http://localhost:6060/pkg/myproject 您可以提到项目的路径，以便下载整个项目的html文档。

Answer 3

您可以尝试金币，它是另一种Go文档生成工具(以及本地docs服务器/代码阅读器)。

在项目目录下，可以运行以下任何命令为Go项目生成HTML文档：

• 黄金-gen -nouses -plainsrc -wdpkgs-列表=促销。
• 金-gen -nouses -wdpkgs-列表=促销。/.
• 金-gen -wdpkgs-列表=推广。/.

第一个命令生成最紧凑的文档，最后一个命令生成完整的文档，其大小是压缩文档的6倍。

顺便说一句，我是“Golds”的作者。希望你这个工具能满足你的需要。