在浏览器中本地查看包文档

怎么入门Golang编程？需要学习哪些知识点？这是新手们刚接触编程时常见的问题；下面golang学习网就来给大家整理分享一些知识点，希望能够给初学者一些帮助。本篇文章就来介绍《在浏览器中本地查看包文档》，涉及到golang，有需要的可以收藏一下

问题内容

我想在本地查看我的包文档的外观。也就是说，我想在godoc.org上看到与您在本地看到的相同的东西。

我在本地有一个简单的示例文件夹，但我无法让它工作。它正确输出文本文档：

~/code/go/gonotes (master) $ godoc .
PACKAGE DOCUMENTATION

package gonotes
    import "."


FUNCTIONS

func Blah()
    Here is header

    Blah is function being use to test:

    - go documentation
    - blah like things

    It is nice

但是，如果我运行godoc -http=:6060并导航到http://localhost:6060/，我看到的内容与我在 golang.com 主页上看到的内容基本相同。 http://localhost:6060/gonotes显示

lstat $GOROOT/gonotes: no such file or directory

我是否误解了-http工作原理？有没有办法在本地预览我的文档的 http 版本？

更新

src/gonotes通过将文件复制到然后运行，我能够让它出现：

GOPATH=/Users/jonah/code/go/gonotes godoc -http=:6060

以便实际文件可在/Users/jonah/code/go/gonotes/src/gonotes.

这具有不显示我默认安装的任何第三方库的副作用GOPATH，所以我仍然想找到一个解决方案，只允许我按原样添加当前目录，而不添加src/curdir它，并且仍然有它出现了。

正确答案

在GOPATH模式

godoc -http将提供所有可用包的文档，包括标准库。不用担心，您自己的包裹也在其中，请再看一遍。作为快捷方式，只需键入http://localhost:6060/pkg/your/package.

在模块感知模式下

GOPATH和模块是 互斥的 ，请参阅[Go Modules 不识别 GOPATH 下的文件](https://stackoverflow.com/questions/55650450/go-modules-does-not- recognize-files-under- gopath/55650622#55650622)。该godoc工具不支持模块，并且已被弃用（请参阅弃用警告），所以现在如果您想在本地查看模块的包文档godoc，您必须将它们的源代码放在一个src文件夹中。

查看模块文档的“解决方法”：

• 将 repo 放在一个文件夹中，例如/some/folder/src

• 启动godocsgodoc -goroot=/some/folder -http=:6060

请参阅相关问题：支持 Go 模块

还分组讨论：go 1.11 godoc 工具是否“模块感知”？

到这里，我们也就讲完了《在浏览器中本地查看包文档》的内容了。个人认为，基础知识的学习和巩固，是为了更好的将其运用到项目中，欢迎关注golang学习网公众号，带你了解更多关于golang的知识点！