开发包时,在发布包之前在本地预览其文档会很有帮助。虽然 godoc 命令可以生成文本文档,但它还提供了 HTTP 服务器模式,用于在浏览器中显示文档。但是,您可能会遇到使其正常工作的困难。
如果您遇到 godoc -http=:6060 不显示您自己的包的文档而是显示 Go 主页的问题,请确保包位于正确的路径中。默认情况下,godoc 在 GOPATH 或模块源代码树中搜索包。如果你的包在这些目录之外,它将找不到。
在 GOPATH 模式下:
在 GOPATH 模式下工作时,godoc -http 将为所有可用的软件包,包括标准库。要查看包的文档,只需导航至 http://localhost:6060/pkg/your/package。
在模块感知模式中:
在模块中-感知模式下,godoc 与 GOPATH 不兼容。因此,要在本地查看模块的文档,您需要将其源代码放在 src 文件夹中。例如,如果您的模块位于目录 /home/user/mymodule 中,请在其中创建一个名为 src 的新目录,并将模块的源文件移到那里。
一旦源文件位于 src 文件夹中,使用以下命令启动 godoc:
godoc -goroot=/home/user/mymodule -http=:6060
这应该允许您在以下位置查看包的文档: http://localhost:6060/pkg/mymodule.
以上是如何使用'godoc”在浏览器中本地查看我的 Go 包文档?的详细内容。更多信息请关注PHP中文网其他相关文章!