问题标签 [godoc]

在一个常见的项目结构中，有如下文件夹：

/cmd

/内部的

/包

但是在执行时godoc

没有为internal文件夹 中的包创建文档： cmd 和 pkg 之间缺少 internal

问题是：包中有一些功能，即使内部使用也需要记录它们。有什么办法吗？

我有一个带有README.md. 出于 godoc 的目的，我添加了doc.go文件，但并不意味着将其包含README.md在 godoc 中。目前，自述文件显示为godoc 的第一部分。是否可以完全隐藏 README 部分？

最近我试图记录我的代码，但是我在使用时遇到了一些麻烦，godoc因为我运行时没有出现一些功能godoc -http:localhost:6060

这就是我的代码的样子：

问题是godoc永远不会渲染func (s *mongoDB) connect() error，但我需要记录下来，你们能向我解释发生了什么godoc吗？或者你可以给我一些解决 Go 代码文档的方法和技巧。

我已经编写了一个库及其具有私有结构的接口实现。在 godoc 中，没有显示结构有界函数。我认为这是因为未公开的结构。但是我的功能是通过界面公开的。有什么方法可以为它创建好的 go doc 吗？还是我应该在接口减速部分解释函数的行为？

我添加了我编写的包的简单版本。这是我编写好的文档所需要的真正的 Go 库。

我只想显示一个包的文档。我已经尝试godoc github.com/user/repo过其他答案，但出现以下错误：

我应该如何使用 godocs 只显示我的包的文档？

我想为我的程序编写一些文档并使用 godoc 生成一个 html 文档页面。

但是，它显示了一些导出的常量和变量。它们是可导出的，因为该程序中的其他包需要它们。但是用户没有必要承认这些常数和变量。在文档中显示它们是丑陋的。

那么我可以在我的个人包的 godoc 页面中隐藏常量和变量部分吗？

godoc自 1.12 以来已从 go 标准安装中删除，并且看起来不会很快更新。pkg.go.dev至少看起来是它的继任者。它还具有其他文档功能，例如抓取README.md文件并将其呈现在文档页面中。

由于这些原因，我希望切换到使用pkg.go.dev本地来查看和创建小型内部包的文档。主要问题是不像godoc似乎没有明确的使用指南。我也不知道pkpg.go.dev这个任务是否完全是矫枉过正。所以我想知道：

1. 可以并且应该pkg.go.dev用作本地godoc替代品吗？
2. 如果是，我将如何为这项任务运行它？

如何创建可见的 Go 文档？

这很容易为 go 中的任何函数创建文档，如下所示：

当我调用该函数时，我可以看到该文档：

我可以编写可以从编辑器/IDE 中看到的包文档吗？我是否必须安装其他工具才能实现包文档的类似行为？

如何找到 Kubernetes Go 客户端的任何子包的确切路径是什么？

我对整个 Go 依赖项 ( go get k8s.io/client-go@latest) 感到困惑，因为我看到很多等价/相似V1或类似的V1beta1前缀XXX有时会在其他时候以我认为任意的方式出现恐慌。

但是，当我检查文档时，很难找到有关接口、结构定义和包名称的信息（我目前被阻止的东西）。

当我在多次点击后转到这里时：https ://pkg.go.dev/k8s.io/api@v0.23.1/core/v1#Container 那么我如何将此 URL 转换为 Go 包？它可能是Container结构的包，但对于任何其他“Kubernetes 事物”都是一样的。

查看https://github.com/kubernetes/client-go/blob/master/examples/out-of-cluster-client-configuration/main.go上的示例，我发现它们正在导入metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"，所以我尝试corev1 "k8s.io/apimachinery/pkg/apis/core/v1"了，但是编译器恐慌

所以我尝试go mod tidy了，但我得到了同样的错误。

我也试过"k8s.io/client-go/util/core"or "k8s.io/client-go/core"- 它不起作用，但必须有一个一致的规则来找出这些包名称。

我习惯于从 GitHub 存储库 URL 推断包名称，例如 importinggithub.com/kubernetes/client-go或类似的，但由于某种原因，在 Kubernetes 中，它们似乎没有以这种方式使用。

如何在https://pkg.go.dev的那些 URL 上找到从这些文档推断包导入的规则？

尝试godoc在一个简单的平面代码文件夹上提供服务。在线文档没有解释如何实现这个简单的任务。

所以，创建这个简单的结构，

main.go 很简单

在 GOPATH 或模块模式下运行时，在浏览器中打开 localhost:6060 不会给出记录当前文件夹的预期结果。

在模块模式下运行会给出以下输出和结果：

并且在 GOPATH 模式下运行似乎指向本地标准库：