doc.go 是包级文档文件，仅被 go doc 工具读取，需以 // Package xxx 开头并紧邻 package 声明，支持简单 Markdown；不可含 import 或逻辑代码，且包名必须与声明一致，否则文档不显示。
doc.go 是包的说明书，不是可执行文件
它不参与编译，只被 go doc 和 godoc（或 pkg.go.dev）读取，用来描述整个包的用途、设计意图和使用前提。Go 不会从 doc.go 里提取函数或类型文档——那些必须写在对应声明前的注释里。
常见错误现象：go doc mypkg 输出空或只有“Package mypkg.”，但你明明写了大段注释——大概率是注释没紧贴 package 声明，中间夹了空行或非注释语句。
- 必须以
// Package xxx开头，且紧挨着package行（允许前面有空行，但不能有其他代码或导入） - 注释块内支持简单 Markdown（如
**bold**、`code`、列表），但不解析 HTML 或复杂格式 - 如果包名是
main，doc.go会被忽略——main包不被go doc索引
怎么写才让 godoc 正确显示包级说明
核心就一条：注释必须是「包声明的前置文档」，不是随便放个文件就行。很多团队把 doc.go 当成 README.md 的 Go 版，结果写了一堆用法示例却没人看得见。
正确结构示例：
Alibabacloud Sdk Client Initialization For Golang
下载
初始化并管理阿里云SDK Go 客户端，涵盖 sync.Once 单例、goroutine 安全、endpoint 与 region 配置、VPC 端点及调试。
立即学习“go语言免费学习笔记（深入）”；
// Package storage provides blob storage backed by S3 or local disk.
// It abstracts away driver-specific details and offers a unified interface.
//
// Example usage:
//
// s, _ := storage.New("s3://bucket-name")
// s.Put(ctx, "key", bytes.NewReader(data))
//
// Drivers supported: s3, fs, memory
package storage
- 第一行必须是
// Package xxx，xxx要和实际包名一致（大小写敏感） - 空行分隔文档与代码，但不能在
// Package和package之间插空行 - 避免在
doc.go里 import 包或写任何可执行逻辑——它只是纯文本容器
doc.go 和 _test.go 文件里的包文档冲突吗
会。如果测试文件（比如 storage_test.go）顶部也写了 // Package storage 注释，go doc 可能随机选一个显示，行为不可靠。
- 只在
doc.go中提供包级文档，测试文件里不要重复写// Package - 测试文件中的注释只用于解释测试用例本身，不影响包文档生成
- 运行
go doc -all mypkg可看到所有文档来源，方便排查是否被意外覆盖
跨平台或模块化项目中 doc.go 容易漏掉的点
当包被拆到子模块（如 github.com/user/repo/v2/storage），或者用 //go:build 条件编译时，doc.go 很容易被误判为不参与构建而被忽略。
- 确保
doc.go没有写//go:build ignore或其他排除标记 - 在多版本模块中，每个版本路径下都要有独立的
doc.go——v1 和 v2 的文档可能完全不同 - 如果包依赖 build tag（如
//go:build !windows），doc.go必须不带任何 build tag，否则在某些环境下无法被索引
最常被忽略的是：改了包名但忘了同步更新 // Package xxx 里的名字，导致文档彻底消失。这不是 bug，是匹配失败。
