在Golang实战开发的过程中，我们经常会遇到一些这样那样的问题，然后要卡好半天，等问题解决了才发现原来一些细节知识点还是没有掌握好。今天golang学习网就整理分享《"Golang VS Code中类型的导出应该带有注释或未导出"》，聊聊，希望可以帮助到正在努力赚钱的你。

我在 go 中尝试了这段代码：

type Agent struct {
    name string    // Not exported
    categoryId int // Not exported
}

vs code 报告以下问题：

导出类型代理应该有注释或不导出

这个警告有点烦人。所以我有以下问题：

• 如何摆脱它？
• 我应该发表什么评论？
• 是否有任何默认评论模板？

它要求我发表评论，但默认情况下不让我添加评论。

解决方案

只需在其上方添加注释，以类型（或函数、方法等）的名称开头，如下所示：

// agent is ...
type agent struct {
   name string
   categoryid int
}

此 linter 错误是由导出的 agent 类型引起的，即使其属性未导出。要不导出您的类型，请以小写形式定义它，如下所示：

type agent struct {
   name string
   categoryId int
}

你的 linter 抱怨这个的原因是 godoc 使用这些注释来自动为你的项目生成文档。您可以在 pkg.go.dev 找到此类记录的 go 项目的许多示例。

例如，如果您将一个 go 项目上传到 github，pkg.go.dev 将使用这些注释自动为您生成一份文档。您甚至可以添加可运行的代码示例和许多其他内容，如 go-doc tricks 所示。

who

此警告由 go 源代码的官方 linter - golint 生成。golint 被 visual studio code 编辑器中的 Go extension 用作默认 linter。 p>

为什么

要了解 golint 显示该警告的原因，我们可以参考与注释相关的 go 官方文档 - "Go Doc Comments"（引用） ：

但是，如果您倾向于编写自记录代码（即，从名称本身等中可以清楚地看出意图，那么这确实可以是annoying ）。

解决方案

除了已经提议的 solutions 之外，您可以开始使用替代的、更高级的 golangci-lint，它是一个 go linters 聚合器。它具有 golint disabled by default，因此不会触发关于缺少文档注释的烦人警告。当然，如果您愿意，可以使用相关的 flags 来打开此警告（请参阅 --排除字符串 和 --排除-使用-default）。

go 扩展的描述页面也提到了更改 linter 的可能性：

如何在 vs code 中更改 go 扩展的 lint 工具

要更改 vs code 中的 lint 工具，请执行以下步骤。

1) 在 go 扩展的管理菜单中选择“配置扩展设置”：

2) 从相关下拉列表中选择“golangci-lint”：

3) 要防止 vs code 由于使用此强大的 linter 而冻结，请添加 --fast 标志，如 "Editor Integration" 说明中所述。

为此，您需要导航到 go 扩展配置页面（如步骤 1 所示），打开 settings.json 文件并添加相关配置，如下面的屏幕截图所示：

注意！以下引用自“golangci-lint”FAQ：

今天带大家了解了的相关知识，希望对你有所帮助；关于Golang的技术知识我们会一点点深入介绍，欢迎大家关注golang学习网公众号，一起学习编程~