问题标签 [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 投票
2 回答
927 浏览

go - 如何使用 godoc 做文档

在我的一个课程中,我们必须使用 godoc 来记录我们的 Go 代码。我们用于该类的代码来自一个 GitHub 存储库,我们必须将其分叉到我们的存储库中。然后从我们的仓库中,我将它克隆到本地仓库。每次我尝试使用创建文档时

它不会更新。是因为它是从其他人的回购中分叉的吗?我相信它会记录本地回购。

0 投票
0 回答
304 浏览

go - 为 my/private/custom 包生成文档作为静态文件

我正在尝试在 Golang 中为我的包生成文档。最终,我想生成文档作为 CI/CD 的一部分并将其托管在我们的网络中。我知道godoc并使用这里的说明,我在我的包目录中完全按照它的说明进行了尝试,但是我得到的只是 go 本身的完整文档,而不是自定义包。

如果我转到:6060/src,我可以看到 src 目录的内容列表,在其中,我可以看到 在此处输入图像描述 但是当我点击它时,我得到了响应 在此处输入图像描述

我不知道这是否是我在文档中看不到我的包的原因,因为 $GOPATH 设置为Users/me/go.

但如果这不相关,我如何为特定包(如我自己的包)生成静态 html 文件?在谷歌上搜索我所期望的答案似乎要困难得多。我知道其他工具使用 doxygen,但 godoc 似乎并不等同

0 投票
1 回答
104 浏览

go - 如何在 Heroku 上提供 godoc 命令

我正在尝试在 Heroku 服务器上提供 godoc -http=:[port]

我在 Heroku 日志中收到以下错误

我的 Procfile 看起来像:

我尝试通过将以下行添加到 Procfile 来安装 godoc

注意:我正在使用 Go 模块

0 投票
1 回答
754 浏览

go - 如何在本地为模块运行 godoc?

我正在尝试在godoc本地运行一个模块,但遇到了这个错误。

在我看来,它像godoc依赖于go list,但不是go list以模块友好的方式运行。

0 投票
3 回答
9920 浏览

go - 未找到 godoc 命令

godoc命令在我的系统上不起作用(我使用的是 Linux Mint 20 Ulyana)。

我刚刚尝试过这个程序:

  1. 使用以下命令安装 godoc:

go get golang.org/x/tools/cmd/godoc

  1. 启动 godoc 服务器:

godoc -http=:6060

结果是: bash: godoc: command not found

我正在使用这个 go 版本go version go1.15 linux/amd64

这是我的 PATH 变量/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/usr/local/go/bin

所有其他 go 命令(go build、go run 等)都能正常工作。

我该怎么做才能使 godoc 命令正常工作?

0 投票
1 回答
122 浏览

go - 如何使用接受 multipart/form-data 的 goDoc 记录我的服务端点

我有一个用 Go/Gin 编写的服务,我接受 multipart/form-data 以接受来自用户的文件列表。代码看起来像这样。

我正在使用 GoDoc 来记录我的端点。那么如何指定我的 godoc 以便 swagger 知道这是一个接受 multipart/form-data 的端点?

0 投票
1 回答
25 浏览

go - 如何快速浏览 godoc 网站上的所有界面

有什么方法可以快速浏览包中的所有界面?

godoc.org现在,在pkg.go.dev文档索引中没有“接口”类型。页面内导航界面将界面识别为无类型。所以目前我使用浏览器搜索“接口”作为关键字,但interface{}也包括接受作为参数的函数。

有任何想法吗?

0 投票
4 回答
2518 浏览

go - 如何在另一个文件中使用 swaggo 中的类型定义?

我正在使用swaggo根据godoc语法生成 API 文档。

源文件夹和文件

对于这个定义:

Response是在另一个文件中定义的,但在同一个包中。

但是当运行swag init生成swagger docs时,它说:

当我将Response结构移动到 时controller.go,它可以工作。

如何用 godoc 或 swago 导入它?

0 投票
1 回答
32 浏览

call-graph - 如何使用“godoc”显示“包内调用图”

如何使用包内调用图godoc中的描述显示“包内调用” ?

我使用这个命令

启动本地服务器,一切都很好。我只是找不到“包内调用图”在哪里。

任何帮助表示赞赏!

0 投票
1 回答
36 浏览

json - json.Compact 是否也验证 json?

我和一位同事正在尝试编写压缩、验证、解析和存储来自客户端的 json 所需的最小逻辑。

这样做后,我们意识到压缩和验证是两个步骤,无论如何都是由 json.Compact 完成的,因为代码表明 json.Compact 调用了 json Scanner。然后扫描程序验证 json 和无效 json 上的错误。

文档没有明确说明,但我们认为是这样。

这是一个链接:https ://forum.golangbridge.org/t/json-compact-appears-to-also-validate-json-but-is-not-documented/23088

让我们知道想法。