go语言注释代码总是飘着黄色波浪线提示:(with optional leading article) (ST1021)go-staticcheck
,非常影响观感。
经过查询发现,go-staticcheck
是一个用于 Go 代码静态分析的工具,用来检测代码中的潜在问题、代码规范以及常见的错误。本次错误信息来自 go-staticcheck 中的规则 ST1021,指的是注释格式的问题
。
该规则要求注释以“类型名 …” 的形式开头,通常需要说明类型的作用或用途。go-staticcheck 之所以强调这个格式,是因为这符合 Go 的 规范和 Effective Go 的建议,有助于生成一致且清晰的文档。
解决方法1
按照规范,将注释修改为以类型名开头
的完整句子格式
// SetRule 是一个定义某种规则的结构体。
type SetRule struct {// ...
}
解决方法2
屏蔽错误提示,配置 IDE 设置
Ctrl + Shift + p
回到代码中发现黄色波浪线消失了。
清爽!