如何只使一个go文档的一部分出现在godocs中

Question

我使用godocs来记录我在go / golang中编写的API，并且我使用godocs记录它，因为我生成了一个包含用于创建API的所有函数的整个main.go文件的HTML页面。但是，我不想显示有关所有辅助函数的信息，我只想显示文件中某些函数的标题信息。有没有办法只允许文件中的某些函数成为文档的一部分，还是我必须为我的所有帮助函数创建另一个文件？ 现在我正在我的本地端口8000上测试它：<div name="login" class="blue_button" onclick=" document.getElementById("form").submit();"><div class="blue_button_text noselect">Login</div></div>

Answer 1

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

  

由godoc提供的网页的演示模式可以通过＆＃34; m＆＃34;来控制。 URL参数;它接受以逗号分隔的标志名称列表作为值：

...

  

例如，http://golang.org/pkg/math/big/?m=all,text以文本形式显示包big的所有（不仅仅是导出的）声明的文档（就像从命令行使用godoc时出现的那样：＆＃34; godoc -src math / big。*＆＃34;）。

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显示未导出的符号以及导出的符号。