如何解析 Go 源文件中的 //go:generate 指令

go 标准库未提供直接提取 `//go:generate` 注释的 api，需手动扫描源码行并解析注释内容；本文详解如何用 `bufio.scanner` 高效识别、提取并处理所有 `go:generate` 指令。

在 Go 工程中，//go:generate 是一种广泛使用的代码生成指令，常用于自动生成 mock、protobuf 绑定、字符串枚举等。但与 //go:build 或 //go:linkname 不同，标准 go/doc 包（如 doc.NewFromFiles）不会解析或暴露 go:generate 注释——它仅提取文档注释（// 或 /* */ 中的说明性文本），而忽略所有以 go: 开头的编译器指令。

要可靠提取 //go:generate 行，核心思路是：逐行扫描源文件，识别以 //go:generate 开头的有效注释行，并剥离前导空格与 // 前缀后进行匹配。以下是一个健壮、轻量的实现方案：

import (
    "bytes"
    "bufio"
    "strings"
)

// extractGenerateDirectives 从 Go 源码字节切片中提取所有 //go:generate 指令
func extractGenerateDirectives(src []byte) []string {
    var directives []string
    scanner := bufio.NewScanner(bytes.NewBuffer(src))

    for scanner.Scan() {
        line := scanner.Text()

        // 跳过空行和纯空白行
        if strings.TrimSpace(line) == "" {
            continue
        }

        // 提取注释文本：支持 "//" 和 "/* ... */" 形式（此处简化处理单行注释）
        // 实际生产环境建议使用 go/scanner 或 go/parser 进行词法分析
        if strings.HasPrefix(strings.TrimSpace(line), "//") {
            comment := strings.TrimSpace(strings.TrimPrefix(line, "//"))
            if strings.HasPrefix(comment, "go:generate ") {
                directives = append(directives, strings.TrimSpace(comment))
            }
        }
    }

    return directives
}

✅ 使用示例：

src := []byte(`package main

//go:generate go run gen.go -type=Config
// This is a doc comment, ignored.
/* go:generate echo "ignored: multi-line comment not parsed here" */
//go:generate protoc --go_out=. proto/service.proto

func main() {}
`)

for _, d := range extractGenerateDirectives(src) {
    fmt.Println("Found:", d)
}
// 输出：
// Found: go:generate go run gen.go -type=Config
// Found: go:generate protoc --go_out=. proto/service.proto

⚠️ 注意事项：

• 上述实现仅处理 // 单行注释中的 go:generate，不解析 /* */ 多行注释内的指令（因 go:generate 规范明确要求必须位于单行 // 注释中，详见 cmd/go/internal/work/generate.go）；
• 若需 100% 兼容 go generate 的语义（如跳过被 //go:build ignore 排除的文件、处理条件编译块），应基于 go/parser 构建 AST 并遍历 File.Comments，但开销显著增加；
• 对于构建工具或 CLI 工具（如 gofumpt、golines 类项目），推荐复用 golang.org/x/tools/go/packages + go/ast 组合，确保与 go 命令行为一致。

总结：解析 //go:generate 不需要重型 AST 分析——对绝大多数场景，精准的行扫描 + 字符串前缀匹配即可高效、可靠完成任务，且完全规避 go/parser 的复杂依赖与性能损耗。