Godoc是用于记录包的一个很好的工具，但是当它被用来反对它时似乎没那么有用 package main。我会看到一个输出只显示我写给自己的笔记 //BUG 和子目录。
Godoc只显示导出的函数，似乎无法从main显示未导出的/函数。我会发现在main中查看函数列表很有用。由于不支持，我倾向于在程序包描述的顶部推送一系列函数，但这感觉就像一个解决方法。
由于我必须手动更新函数列表，因此我经常在包中放入尽可能多的代码，以便将其导出并记录下来。这是一个好主意吗？关于main中的函数列表，我该怎么办？
例：
COMMAND DOCUMENTATION
Package main implements a web server, template renderer and DAL for MySQL.
<filename.go>
<function>(<signature>)
main.go
main()
bootstrap() error
<more functions here>
BUGS
[filename.go] <whatever...>
SUBDIRECTORIES
auth
common
debug
storage
<more packages here>
你需要构建一个稍微修改过的版本 godoc 记录主要包裹。
请参见 https://github.com/golang/go/issues/5727。
TL;博士：
修改以下行 $GOPATH/src/golang.org/x/tools/godoc/server.go
- info.IsMain = pkgname == "main"
+ info.IsMain = false && pkgname == "main"
构建和安装 go install golang.org/x/tools/cmd/godoc。
$GOPATH/bin/godoc 现在应该按照你的意愿行事。
AFAIK，你已经有了问题的答案。我可以想到两种替代解决方案：
- 维护一个显示函数的godoc分支
main 包。 （然后你必须自己在网络服务器上运行它的一个实例。缺点是人们直接去godoc.org获取你的包文档会错过。）
- 分开你的
main 包进入子包这样的 main 包装很小或很小。然后可以在这些子包中读取文档。但据我所知，这并不是普遍的做法。
我认为一般来说，godoc是为了 包 文档。文档 main 软件包实际上只对编辑该软件包源代码的人有用 - 因此可以想象文档不需要公开。另一方面，这缺乏godoc的漂亮表现/组织。
作为妥协，如果您真的想要宣传文档，我建议您对程序的体系结构进行概述，而不是每个函数的逐个播放。
你需要构建一个稍微修改过的版本 godoc 记录主要包裹。
请参见 https://github.com/golang/go/issues/5727。
TL;博士：
修改以下行 $GOPATH/src/golang.org/x/tools/godoc/server.go
- info.IsMain = pkgname == "main"
+ info.IsMain = false && pkgname == "main"
构建和安装 go install golang.org/x/tools/cmd/godoc。
$GOPATH/bin/godoc 现在应该按照你的意愿行事。
AFAIK，你已经有了问题的答案。我可以想到两种替代解决方案：
- 维护一个显示函数的godoc分支
main 包。 （然后你必须自己在网络服务器上运行它的一个实例。缺点是人们直接去godoc.org获取你的包文档会错过。）
- 分开你的
main 包进入子包这样的 main 包装很小或很小。然后可以在这些子包中读取文档。但据我所知，这并不是普遍的做法。
我认为一般来说，godoc是为了 包 文档。文档 main 软件包实际上只对编辑该软件包源代码的人有用 - 因此可以想象文档不需要公开。另一方面，这缺乏godoc的漂亮表现/组织。
作为妥协，如果您真的想要宣传文档，我建议您对程序的体系结构进行概述，而不是每个函数的逐个播放。