当前位置：首页 > 文章列表 > Golang > Go教程 > Go go/doc.Examples 怎样区分空输出与未声明输出

Go go/doc.Examples 怎样区分空输出与未声明输出

来源：17golang原创 2026-11-05 19:31:11 0浏览收藏

go/doc.Examples 返回的 Example.Output 为空字符串，既可能表示没有输出声明，也可能表示显式声明了空输出。需要同时读取 EmptyOutput：它为 true 表示期望空输出；它为 false 且 Output 为空时，表示未声明输出。不要仅用 Output == "" 把两者合并。

官方地址：https://pkg.go.dev/go/doc

先确定工具只抽取声明

为文档系统整理示例时，可以把测试源码当作文本交给 parser，再让 doc.Examples 从 AST 中抽取记录。这个工具的职责是识别注释声明，不是运行示例。对来源代码保持这个边界，既能避免误把预期文本写成实测输出，也不需要执行源文件内的函数。

本文示例在普通 Go 程序中使用标准库，不启动子进程、不调用 go test，也不把 Play 非空视为执行成功。本次文章没有运行下面的代码。

保留注释后，再提取 Example

关键参数是 parser.ParseComments。输出声明存在于注释中，解析时丢掉注释，后续自然无法可靠地区分状态。下面把三个原创示例放在一个源码字符串里，分别表达空输出、无声明和非空输出。

package main

import (
    "fmt"
    "go/doc"
    "go/parser"
    "go/token"
)

// classify 只解释源文件里的输出声明，不判定示例是否运行成功。
func classify(e *doc.Example) string {
    if e.EmptyOutput {
        return "显式空输出"
    }
    if e.Output != "" {
        return "声明非空输出"
    }
    return "未声明输出"
}

func main() {
    // 三种原创输入；字符串里的代码仅作为解析材料，不会被调用。
    src := `package sample_test
import "fmt"

// Example_blank 声明预期没有输出。
func Example_blank() {
    // Output:
}

// Example_missing 没有输出声明。
func Example_missing() {
    // 这里只是普通注释。
}

// Example_text 声明预期文本。
func Example_text() {
    fmt.Println("ready")
    // Output: ready
}
`
    fset := token.NewFileSet()
    file, err := parser.ParseFile(fset, "sample_test.go", src, parser.ParseComments)
    if err != nil {
        fmt.Println("解析失败:", err)
        return // 解析失败时不生成看似完整的声明清单。
    }
    for _, e := range doc.Examples(file) {
        fmt.Printf("%s: %s, Output=%q, EmptyOutput=%t\n",
            e.Name, classify(e), e.Output, e.EmptyOutput)
    }
}

Example_blank 的 Output 为空，EmptyOutput 为 true；Example_missing 的 Output 为空，EmptyOutput 为 false；Example_text 的 Output 包含 ready 对应的预期文本。这里给出的是代码语义推导，没有伪造终端运行记录。打印时使用 %q 是为了让换行等不可见字符可辨识。