在golangci-lint中启用静态检查的ST1020和ST1021规则

golangci-lint作为Go语言生态中广泛使用的代码质量检查工具，集成了多种静态分析工具，其中就包括staticcheck和stylecheck。这两个工具提供了丰富的代码检查规则，但某些规则默认是被禁用的，比如ST1020和ST1021。

默认禁用的检查规则

staticcheck和stylecheck中有部分规则虽然存在，但默认情况下不会执行。这些规则包括ST1020（检查文档注释格式）和ST1021（检查文档注释内容）。这种设计是因为这些规则可能在某些项目中过于严格，或者会产生大量误报。

如何启用这些规则

要在golangci-lint中启用这些默认禁用的规则，需要完成两个步骤：

1. 在linters-settings配置中明确指定要启用的规则
2. 关闭默认的规则排除机制

配置示例如下：

linters-settings:
  staticcheck:
    checks: ["all", "-ST1000"]
  stylecheck:
    checks: ["all", "-ST1000"]
    
issues:
  exclude-use-default: false

配置解析

• checks: ["all", "-ST1000"]表示启用所有检查规则，但排除ST1000
• exclude-use-default: false是关键配置，它告诉golangci-lint不要使用默认的规则排除列表

注意事项

启用这些额外的检查规则后，可能会发现代码中存在以下问题：

1. 文档注释格式不规范（ST1020）
2. 文档注释内容不完整或描述不准确（ST1021）

这些检查可以帮助团队保持代码文档的一致性和质量，但也可能需要在项目中逐步修复相关警告，而不是一次性全部解决。

最佳实践

对于大型项目，建议：

1. 先在CI中启用这些规则但设置为警告而非错误
2. 逐步修复现有问题
3. 确认团队对这些规则的接受度后，再将其设置为必须通过的检查

通过这种方式，可以在不中断现有开发流程的情况下，逐步提高代码文档的质量标准。