go - 为整个项目生成 godoc 文档？

Question

我一直在研究 godoc，发现“go doc”更适合从命令行提供使用帮助，例如:

go doc -cmd -u

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

go doc *function*

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

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

godoc -html hello

生成仅包含包注释的 html 到标准输出

godoc 是一个非常令人困惑的名字，因为我们也有 go doc!

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

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

Answer 1

is there a canonical way to generate documentation for offline use even using godoc?

Go 1.12 (February 2019)对此更清楚:

godoc and go doc

In Go 1.12, godoc no longer has a command-line interface and is only a web server.
Users should use go doc for command-line help output instead.

go doc now supports the -all flag, which will cause it to print all exported APIs and their documentation, as the godoc command line used to do.

cmd/doc: add -all flag to print all documentation for package

Unlike the one for the old godoc, you need the -u flag to see unexported symbols.
This seems like the right behavior: it's consistent.