问题标签 [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 回答
1676 浏览

go - Godoc 文档不输出列表

在我负责测试和记录的整个项目中,我为函数和方法创建了文档,格式如下:

老板和其他程序员赞成这种格式,但问题是godoc不识别列表:

在此处输入图像描述

有没有办法让列表被识别?

在某种程度上,Visual Studio Code 可以很好地识别此文档,尽管有点错误。

0 投票
4 回答
22336 浏览

go - 为整个项目生成 godoc 文档?

我一直在与 godoc 搏斗,发现“go doc”更多地用于从命令行提供使用帮助,例如:

列出包注释和任何功能(或其他实体)

然后显示单个函数(或其他实体)的文档

似乎有一个名为godoc的相关工具。godoc 似乎也基于每个包和功能生成 html。例如

仅生成包含包注释的 html 到标准输出

godoc是一个非常令人困惑的名字,因为我们也有go doc

如何为整个项目创建静态文档?

这类似于Godoc,为整个包创建 html,这可能被误解为询问包的文档而不是项目。我想要一个可以在原则上可能包含许多包和应用程序的项目中使用的构建步骤。

0 投票
1 回答
1251 浏览

go - 如何使用 godoc 创建文档?

我在应用程序中创建了简单的 go,并在应用程序中对我尝试过 godoc -html 的函数和包以及我的应用程序和结果进行了注释

为什么我没有看到我的其他文件?以及为什么<p>for 包有空格

0 投票
1 回答
647 浏览

godot - Godot游戏引擎中的Mainloop是什么?

我是一个godot初学者。所以我只需要帮助,如果有人可以解释一下和操作系统的事情。我被困住了。主循环如何工作以及它如何与他们在 godot 文档中声明的操作系统交互。

0 投票
1 回答
453 浏览

go - 运行“go doc”会导致“no such tool”错误

我遇到了一个非常奇怪的问题,即使我确定解决方案很简单,但我在网上找不到任何关于此的内容。尝试使用go doc <args...>任何一组参数总是会导致错误:

go tool: no such tool "doc"

尽管doc出现在命令输出中go helpgo help doc提供了go doc.

这里发生了什么?我什至尝试从 golang.org 下载 tar.gz 包,因为我认为我安装的版本可能pacman不好,但解压缩后的版本go也有同样的问题(当然,经过适当修改GOPATH)。

0 投票
2 回答
351 浏览

go - 如何从 golang oauth2 正确读取错误

fprintf 的输出是:

我想检查“错误”是否=“code_already_used”。对于我的生活,我无法理清如何。

如何检查/返回/读取错误的“error”或“error_description”?

我查看了 oauth2 代码,它比我高一点。

怎么猜我想看到 (*RetrieveError) 部分。正确的?

谢谢你!

0 投票
1 回答
109 浏览

go - Godoc:将文档限制为项目(不是依赖项)

我正在尝试使用 Godoc 为项目生成一些基本文档,但每次我这样做时,它都会为所有 Go 包添加文档。有没有办法控制它并让它只为我的项目代码生成文档?

我在用着:

0 投票
1 回答
122 浏览

go - 如何使用 go 1.13 安装从 golang 中删除的静态内容

在 go 1.13 之前,我可以将 go 附带的 godoc 版本运行为godoc -http localhost:6060. 这不仅会显示我所有源代码的文档,还会显示来自 go 网页的静态内容,包括例如 go 语言规范。

使用 go 1.13 使这些内容离线可用的最简单方法是什么?我当然可以安装 godoc 并查看我自己的 godoc 文档,但不能查看其他网站的内容。我尝试了类似go get -u golang.org/x/website无济于事的事情。

对于它的价值,我使用的是 arch linux,所以如果 go get 无法做到这一点,我也会对安装 arch 或 AUR 包感兴趣。

0 投票
1 回答
597 浏览

go - 忽略“godoc”输出中的外部依赖项和标准库

我有一个使用 Go Modules 的 Go 项目。我想用来godoc为这个项目的包生成文档。目前,我正在使用:

当然,这会生成项目的文档,但它也会生成标准库和导入的依赖项的文档。

有什么办法可以忽略这些吗?他们充其量只是觉得多余。如果无法忽略它们,是否有任何方法可以为项目的包使用godocgo doc生成 HTML 格式的文档?

0 投票
1 回答
375 浏览

go - What does it mean if a field is "filtered" in Go?

In the Go documentation a type often shows only the exported fields. For example, the time.Timer documentation (https://golang.org/pkg/time/#Timer) shows the following:

type Timer

The Timer type represents a single event. When the Timer expires, the current time will be sent on C, unless the Timer was created by AfterFunc. A Timer must be created with NewTimer or AfterFunc.

Go capitilizes to differentiate exported vs unexported fields, so this is clear. However, what does it mean (for example in the context of the comment above) to contain "filtered" fields?