如何让Go Doc关联类型别名与函数变量别名的原有文档？

Go的类型别名和函数变量别名本身不会自动继承原符号的文档注释，Go Doc只会解析当前包内直接定义的注释内容，这就是你遇到问题的根源：类型别名MyType能显示原类型的方法（因为方法属于原类型本身），但不会自动拉取原包的结构体字段注释；而NewMyType作为变量，Go Doc只会显示它的类型签名，不会关联原函数的文档。

以下是具体的解决方案：

1. 处理类型别名的文档显示 #

对于类型别名，你需要在别名上方手动添加文档注释，有两种常用方式：

• 复制原类型的完整注释：把原models.MyType的结构体字段注释、说明等直接复制到别名的注释中，确保用户在当前包就能看到完整文档。
• 引导至原类型文档：在注释中说明该别名等同于原包的类型，并通过Go Doc支持的链接语法（[原包.原类型名]）指向原类型的详细文档。

示例修改后的类型别名：

// MyType 封装了重复次数和目标文本的数据结构，等同于 models.MyType
//
// 字段说明：
//   num - 文本的重复次数
//   text - 需要重复的目标文本
//
// 更多方法细节可查看 [models.MyType]
type MyType = models.MyType

2. 处理函数别名的文档显示 #

不要用变量赋值的方式（var NewMyType = models.NewMyType），而是编写一个包装函数，在包装函数上方添加和原函数一致的文档注释，内部直接调用原函数。这样既保留了原功能，又能让Go Doc解析到完整的函数文档。

示例修改后的函数包装：

// NewMyType 创建指定参数的 MyType 实例
//
// 参数：
//   num - 文本的重复次数
//   text - 需要重复的目标文本
//
// 返回初始化完成的 MyType 实例
func NewMyType(num int, text string) MyType {
    return models.NewMyType(num, text)
}

修改后的完整alias.go示例 #

package mymodule

import "your-module-path/models"

// MyType 封装了重复次数和目标文本的数据结构，等同于 models.MyType
//
// 字段说明：
//   num - 文本的重复次数
//   text - 需要重复的目标文本
//
// 更多方法细节可查看 [models.MyType]
type MyType = models.MyType

// NewMyType 创建指定参数的 MyType 实例
//
// 参数：
//   num - 文本的重复次数
//   text - 需要重复的目标文本
//
// 返回初始化完成的 MyType 实例
func NewMyType(num int, text string) MyType {
    return models.NewMyType(num, text)
}

这样修改后，Go Doc就能正确显示别名的完整文档，同时完全保留原有的功能逻辑。

内容的提问来源于stack exchange，提问作者Jaxton Winder