问题标签 [godoc]

根据“有效围棋” golang.org/doc/effective_go

程序中的每个导出（大写）名称都应该有一个文档注释。

假设我在一个简单的 Web 应用程序上有一个视图处理程序

我的问题是：那个 godoc真的有必要吗？也许我现在只是爱上了 Robert Martin 的 Clean Code，但它似乎是一个有效命名的变量，在这种情况下FrontPageView不需要这样的 godoc。这可能是“需要 javadocs 吗？”的衍生/重复。或“是否需要 python 文档字符串？”，但我确实想确保在学习一门新语言时，我坚持使用特定于语言的规范做事方式。

我是新手Go，正在编写一个测试应用程序，并想记录它。我的申请在GOHOME\src\myapp.

我可以使用以下命令启动服务器并使用浏览器查看文档。这有效：

但是，我想生成 HTML 文件并将文件复制到服务器，以便其他人可以阅读它们。我试过了：

和

我总是收到以下错误：

未找到匹配项。

我应该怎么做才能生成所有文档文件？

在我的用例中，我想知道如何在 Go 中实现以下 Java 代码

我能够导入math/big包并创建大整数，但无法Pow()在 Go 中执行功能。我也没有在 Go doc中找到该功能。

我是否必须实现自己的Pow()for bigint 版本？有人可以帮我吗？

我有一个私有结构（实际上不止一个，我为这个例子做了一点简化），我有一个公共函数，它满足一个公共接口。这个结构是通过工厂方法（NewX 风格）创建的：

我不能让工厂方法返回公共接口，因为在我的项目中，返回值还有其他接口需要满足。

我确实想通过 godoc 记录 PublicFunction()，但因为它位于私有结构上，所以它不会显示：

有什么方法、技巧、解决方法等让 privatestruct.PublicFunction() 在 Godoc 中可见？

我的实际用例更加严重：我确实有不止一个私有结构。它们都满足 PublicInterface，但是它们各自的 PublicFunction 实现的内部工作方式不同，因此它们的文档是否也需要不同......

我想查看该godoc工具的源代码，但找不到。我在哪里可以找到它？

我在多语言项目仓库中有一个 Go 子项目。我希望能够使用“go get”和“go doc”。

我的布局看起来像：

我在网站上设置了 go-import 标签，并在 repo 根目录中创建了一个“go”符号链接，这样我就可以了go get qpid.apache.org/proton/go/<package>。有用！！它将整个项目 repo 克隆到我的 GOPATH 中，但这没关系。

问题是如果我运行 godoc -http 它会做以下坏事：

• 完全忽略根“go”符号链接
• 将我的包记录为“qpid.apache.org/proton/proton-c/bindings/go/”
• 显示目录的包路径，其中没有任何内容。

命令行“godoc qpid.apache.org/proton/go/package”确实做了正确的事情，所以 godoc 可以正确提取文档，但是 godoc -http 的“目录浏览”功能太多了，没有遵循符号链接. 那么我可以限制/控制 godoc 选择的文档吗？

我阅读了https://github.com/golang/gddo/wiki/Source-Code-Links，但我认为这对我的问题没有帮助，可能是错误的。

我仍在努力以一种快速理解的方式来表达这个问题，所以我将记录我遇到的问题所遵循的步骤。

1. 我正在查找 net/http 包中 Request 结构的文档。我这样做是通过godoc net/http Request
2. 现在浏览文档，请求结构的第一个字段是 URL，它是*url.URL我想查找其文档的类型。
3. 但是 godoc 没有详细说明它属于哪个导入路径。我只知道包名称本身是“url”，但它的规范导入路径类似于“some/path/url”，我想知道这样我就可以查找它并找出 URL 字段。

我要遵循哪些步骤来获取url上述文档中引用的特定包？

我有几个与 godoc 兼容的 Go 项目。我们使用 godoc 作为文档服务器在内部共享文档和代码，没有重大问题。但是，当我们想与第三方共享文档时，我们需要更多地控制打开代码。有没有办法以显示类型和文档但从不链接或显示源代码的特殊模式运行 godoc？

我试过了

但不起作用，仍然可以链接到类型定义代码。只是想知道是否错过了某事。去版本，1.3。

I find Godoc a great tool to automatically generate docs. But I found that, if I define a custom type and use it in my constant definition, in the godoc HTML, the constants will be displayed under that type, but not in the package level.

Here's a simple example:

This will generate a "Constants" heading at the top of the godoc. But if I do the following, there will be no Constants heading for the package

In the godoc output, the constants will be displayed under type Level, somewhere in the middle of the document, but not at the top and not in the package level.

Is there any way to use custom types, but still put the const definitions in the package level in godoc?

我正在尝试在本地构建godoc.org源代码以进行一些更改。我的工作目录是/Users/Dany/go/src/github.com/golang/gddo. 在 gddo-server 包中有几个文件。其中一个 go 文件使用了另一个文件中的函数，该文件在同一个包中但未导出。它正在抛出Undefined: <function-name>异常。

文件夹是结构是，

我们如何在不同文件中使用同一包中未导出的函数？谁能帮我解决这个问题。另外，如果有人对如何构建 godoc.org 代码有任何想法？