在使用 go:generate 和 go 模板自动生成 go 代码时，不应尝试直接对含 {{...}} 的模板文件运行 gofmt；而应在模板执行后、写入输出文件前，用 go/format.source 对生成的原始 go 代码字节进行格式化。
在使用 go:generate 和 go 模板自动生成 go 代码时，不应尝试直接对含 {{...}} 的模板文件运行 gofmt；而应在模板执行后、写入输出文件前，用 go/format.source 对生成的原始 go 代码字节进行格式化。
Go 模板（.tmpl 或 .gotmpl）本身不是合法的 Go 源文件——它混杂了 Go 语法与模板指令（如 {{.Field}}、{{range .Items}}），因此 gofmt 解析失败是预期行为，并非你遗漏了什么隐藏特性。官方 gofmt 工具设计目标明确：仅处理有效的 Go 源码文件，不支持模板语法扩展。
正确的实践是在代码生成流程中嵌入格式化环节。典型做法是：
- 执行模板 → 输出到 *bytes.Buffer
- 将缓冲区内容（即已渲染的纯 Go 代码）传给 go/format.Source()
- 将格式化后的字节写入目标 .go 文件
以下是可直接复用的核心代码片段：
import (
"bytes"
"go/format"
"os"
"text/template"
)
func generateAndFormat(t *template.Template, data interface{}, outputPath string) error {
var buf bytes.Buffer
if err := t.Execute(&buf, data); err != nil {
return err
}
// 格式化生成的 Go 代码（注意：输入必须是合法 Go 源码）
formatted, err := format.Source(buf.Bytes())
if err != nil {
return fmt.Errorf("failed to format generated code: %w", err)
}
return os.WriteFile(outputPath, formatted, 0644)
}⚠️ 注意事项：
- format.Source() 要求输入字节必须是语法正确的 Go 代码。若模板渲染结果存在语法错误（如漏掉括号、未闭合字符串），将返回格式化错误，此时应优先修复模板逻辑而非跳过校验。
- 不要对模板文件本身运行 go fmt 或 gofmt——这既无意义，也易引入误导性修改（例如误删 {{ 或重排模板结构）。
- 若需提升模板可读性，可借助缩进控制（如 {{- if .Cond}}）、注释（{{/* comment */}}）及合理分段，但其格式风格应独立于 Go 代码规范。
总结：gofmt 和 go generate 协同的关键在于分层处理——模板负责逻辑抽象与代码生成，go/format 负责输出净化。这种职责分离不仅符合 Go 工具链设计哲学，也能确保生成代码始终符合团队统一的代码风格标准。
