go - 从 godoc 中排除 Github 项目的 README 部分

Question

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

标签： gogithubgodoc

Answer 1

我找到了一个很好的解决方案，只需将您的文件放在 Github 上README.md的文件夹中，它就不会显示在 godoc 中，但仍会显示在 Github 上。docs

我在 Github 上为我的项目做了这个，你可以看到godoc 没有显示README.md内容。

编辑：

在对您的 github 存储库进行适当的更改后，您将需要发布一个新的补丁版本来pkg.go.dev更新这些更改。