问题标签 [godoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
3 回答
968 浏览

macos - 在 OS X 中自动启动 godoc localhost 服务器?

在 Go 中,您可以启动 HTTP 服务器,然后通过特定端口浏览 Go 文档。例如,如果您godoc -http=:3333在终端中输入,则 localhost 服务器开始在端口 3333 上工作,然后您可以查看 Go 官方文档。

但是,我想让它在我登录 OS X 系统时自动启动,因为即使在我断开 Wi-Fi 连接的情况下,用 Go 代码编写它也非常强大和方便。那么在 OS X 中使用这样的守护进程是否可行?

我已经从这里的示例中实现并使用了 MongoDB 中的确切功能,而这正是我想要实现的这种服务......

0 投票
2 回答
6517 浏览

go - 在 Godoc 中记录 `package main` 需要哪些步骤?

Godoc 是记录软件包的好工具,但是当它用于package main. 我将看到一个仅显示我使用//BUG子目录和子目录写给自己的笔记的输出。

Godoc 只显示导出的函数,似乎无法从 main 中显示未导出的 / 函数。我会发现在 main.js 中查看函数列表很有用。由于不支持此功能,我倾向于在包描述的顶部添加一个功能列表,但这感觉像是一种解决方法。

由于我必须手动更新函数列表,因此我经常将尽可能多的代码放入包中,以便将其导出并记录下来。这是一个好主意吗?我应该如何处理 main 中的函数列表?

例子:

0 投票
0 回答
661 浏览

go - 如何让 godoc 为我的项目生成导入依赖图?

我已经在我的 Mac 上安装了 go;并且 godoc 似乎可以工作,但是使用时godoc -http=...我会得到很好的页面,但没有依赖关系图。

0 投票
1 回答
2498 浏览

github - 如何使 godoc 链接到 github 上的源代码

在 godoc 站点上,大多数库(例如http://godoc.org/github.com/beego/memcache)直接链接到 github 上的源代码。当我在本地运行 godoc 工具时,情况并非如此。我们的团队也有一个本地 godoc 服务器,它同样没有链接到 github 上的源代码。我们的代码存储在 github 上,并进行了相应的组织(即 github.com/mycompany/packagename)。有没有办法告诉 godoc 工具链接到 github 上的代码,即使它在私人仓库中?

0 投票
3 回答
1066 浏览

go - 如何在一些流行的 go repo 上运行 godoc?

新的 godoc 有一些不错的功能,例如调用者列表等。无论如何我运行它时遇到问题,例如:

有谁可以告诉我如何在我上面使用的一些流行的 go repos 上运行它,比如 etcd?

0 投票
5 回答
30247 浏览

go - 你如何为使用 godoc 作为网页的 go 程序提供简单的文档?

我试图将特定的本地 go 文件作为文档网页提供,但无法做到。

官方 godoc 文档说:

使用 -http 标志(即 godoc 命令),它作为 Web 服务器运行并将文档显示为网页。

这确实会创建类似于 go 页面的内容,但它不会呈现我想要呈现的特定文件。所以我试图提供我想要的文件的名称:

但是,它只是回复:

我也试过:

但它没有用。

我也试过:

但它回答说:

我什至尝试只生成 html 本身:

与上述相同的错误。

我也试过(因为它抱怨 pkg 目录中没有文件):

最后,我放弃了。我不知道这个 godoc 是如何工作的。我安装了 hello.go 程序,以便工作区的 pkg 文件中有一些内容。您如何使用您的代码文档生成网页?

0 投票
1 回答
943 浏览

go - godoc 为什么不跳过 golang 中的示例?

我试图制作文档并提供示例,但我不明白如何做,因为 godoc 跳过了我的示例。

当我进入localhost:8080/pkg/hello_example浏览器时,它会在终端上打印:

我不明白,所以我不能随意命名示例?这些名称是否必须与我的包或文件的函数名称匹配?这是在我的测试包中,所以我可能正在尝试在不同的包和文件中测试功能。我该怎么做呢?

0 投票
1 回答
497 浏览

godoc - Godoc自己的Sourcecode

我想在文件夹“MyOwnProject”中为我自己的项目创建一个文档。标准似乎是 Godoc,帮助告诉我使用 godoc 包 [name...] 它似乎并不难:

一方面,它添加的目录 /src/pkg/ 没有任何意义,东西要么在 go/pkg 要么 go/src 中。接下来它似乎在寻找一个文件。我希望它适用于为该项目提供的所有文件。我的参数做错了什么?

0 投票
1 回答
301 浏览

go - 如何在 Godoc 中隐藏标准库?

我通常使用“godoc -http=0.0.0.0:6060”启动 GoDoc 服务器,用于与东西共享文档。问题是它总是将内置库的文档与我的应用程序混合。经过一番搜索,目前似乎不支持 std lib 隐藏功能..(如果有错误请更正)

那么,是否有任何黑客可以帮助隐藏标准库?

或者以不同的方式问,有没有办法选择路径/包来显示?

0 投票
1 回答
304 浏览

go - 如何使用 `godoc -http=:6060` 显示内置类型?

如果我开始

然后打开(例如通过在某处用作类型http://localhost:6060/pkg/builtin/#string的函数声明),我得到一个大红色“打开/usr/local/Cellar/go/1.3.3/libexec/src/builtin:没有这样的文件或目录”。string

如何让 godoc 以与http://golang.org/pkg/builtin/#string相同的方式工作?

我试过go get builtin了,但这并没有改变任何东西。DuckDuckGo 和谷歌搜索也没有照亮我。

(我在 OS X 上使用 Homebrew 安装了 Go。)