go - 如何只在 godocs 中显示 go 文档的一部分

Question

我正在使用 godocs 来记录我用 go/golang 编写的 API，并且我正在使用 godocs 来记录它，因为我生成了整个 main.go 文件的 HTML 页面，其中包含用于创建我的 API 的所有函数。但是，我不想显示有关我的所有辅助函数的信息，我只想显示有关文件中某些函数的标题信息。有没有办法只允许文件中的一些函数成为文档的一部分，或者我必须为我的所有帮助函数创建另一个文件？现在我正在本地端口 8000 上对其进行测试：godoc -http=:8000

Answer 1

godoc及其近亲go doc命令的默认行为显示导出声明的包文档。奇怪的是，我没有找到一个简单的权威来源来链接到明确记录这一事实，但是在改变默认行为的命令中引用了该事实的推断，例如来自godoc 包的文档：

godoc服务的网页的展示方式可以通过“m”URL参数来控制；它接受以逗号分隔的标志名称列表作为值：

...

例如，http ://golang.org/pkg/math/big/?m=all,text 以文本形式显示了 package big 的所有（不仅仅是导出的）声明的文档（使用 godoc 时会出现）从命令行：“godoc -src math/big .*”）。

https://golang.org/src/go/doc/doc.go的源代码包括：

81    const (
82        // extract documentation for all package-level declarations,
83        // not just exported ones
84        AllDecls Mode = 1 << iota
...
89    )

并且https://golang.org/src/go/doc/exports.go记录了一个函数：

241    // fileExports removes unexported declarations from src in place.

最后go doc -h在终端中运行会显示一个标志：

-u 显示未导出的符号以及导出的符号。