0

godoc自 1.12 以来已从 go 标准安装中删除，并且看起来不会很快更新。pkg.go.dev至少看起来是它的继任者。它还具有其他文档功能，例如抓取README.md文件并将其呈现在文档页面中。

由于这些原因，我希望切换到使用pkg.go.dev本地来查看和创建小型内部包的文档。主要问题是不像godoc似乎没有明确的使用指南。我也不知道pkpg.go.dev这个任务是否完全是矫枉过正。所以我想知道：

  1. 可以并且应该pkg.go.dev用作本地godoc替代品吗？
  2. 如果是，我将如何为这项任务运行它？
4

2 回答 2

0

单独运行godoc[1] 对我有用，但速度很慢，因为它会为标准库中的每个包生成文档，而我只关心我正在处理的本地包。为此，如果您的包位于名为 的文件夹中something，您可以移动该文件夹，使其如下所示：

godoc/src/something

然后，进入godoc文件夹，运行

godoc -goroot .

然后，浏览到localhost:6060。或者，另一个站点可用于 Go 文档 [2]。

  1. https://github.com/golang/tools/tree/master/cmd/godoc
  2. https://godocs.io
于 2021-10-25T15:09:53.460 回答
0

您可以使用具有先前 godoc 工具的x/tools/godoc

于 2021-10-25T15:06:32.193 回答