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

我想在本地查看我的包文档的外观。也就是说,我想在本地看到与您在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到它,并且仍然有它出现了。


largeQ
浏览 133回答 1
1回答

侃侃无极

在GOPATH模式godoc -http将提供所有可用包的文档,包括标准库。不用担心,您自己的包裹就在其中,再看一遍。作为快捷方式,只需键入http://localhost:6060/pkg/your/package.在模块感知模式下GOPATH和模块是互斥的,该godoc工具不是模块感知的,它正在被弃用,所以现在如果你想在本地查看模块的包文档godoc,你必须求助于将它们的源放在一个src文件夹中。查看模块文档的“解决方法”:将回购放在一个文件夹中/some/folder/src开始godocsgodoc -goroot=/some/folder -http=:6060
打开App,查看更多内容
随时随地看视频慕课网APP

相关分类

Go