在 Go 模块中如何使用 godoc 提供文档?
在 Go 模块中使用 godoc 生成文档时,可能会遇到工具不支持模块的问题。虽然 go doc 命令不能生成 HTML 页面,但可以采用解决方法来使用 docker 容器运行 godoc 服务器。通过设置 gopath 为开发树的根目录,godoc 服务器可以为开发树中的所有包提供文档,无论其是否包含 go.mod。
godoc 工具似乎不支持 Go 模块。
一个简单的 godoc -goroot=. 提供项目文件,但它不会生成包的文档。我在项目源目录中对其进行了测试,其中还存储了 go.mod 和 go.sum 模块文件。
如何为 Go 模块内的所有包生成文档 - $GOPATH 之外?
Go 1.12 的发行说明中写道,godoc 工具将不会包含在未来的 Go 版本中,并且只能在 Go 1.12 之后通过 go get 获得。应使用 Go go doc 命令。但是,go doc 不会生成“易读”的 HTML 页面。 是否有其他方法可以从输出 HTML 或 Markdown 的 Go 源代码生成文档?
解决方案
问题不在于模块,而在于 gopath。有一个 github 问题线程更详细地讨论了这个问题:https://github.com/golang/go/issues/26827
该线程已经发展了一种解决方法,使用 docker 容器来运行 godoc 服务器,并将 gopath 设置为开发树的基础。该 godoc 服务器将为您的开发树中的所有包提供文档,无论它们是否有 go.mod。
这是我今天早上刚刚在该线程中发布的解决方法的一个版本 - 修改 $devbase (或将其作为 $1 传递)以指向树的底部:
#!/bin/bash
set -x # optional
devbase=$HOME/gohack
port=6060
docker run \
--rm \
-e "GOPATH=/tmp/go" \
-p 127.0.0.1:$port:$port \
-v $devbase:/tmp/go/src/ \
--name godoc \
golang \
bash -c "go get golang.org/x/tools/cmd/godoc && echo http://localhost:$port/pkg/ && /tmp/go/bin/godoc -http=:$port"
您会注意到,我还使用了 gohack 工具——它为您管理 go.mod 中的“替换”行,因此即使模块尚未推送到服务器,导入也会找到您的本地版本的模块。 $devbase 在其他方面没有什么特别的——例如,将它指向 $home/src 也应该同样有效。
好了,本文到此结束,带大家了解了《在 Go 模块中如何使用 godoc 提供文档?》,希望本文对你有所帮助!关注golang学习网公众号,给大家分享更多Golang知识!
揭开Python中异步编程的秘密:利用协程创造卓越EFForts
- 上一篇
- 揭开Python中异步编程的秘密:利用协程创造卓越EFForts
- 下一篇
- 解密golang协程的高效率
-
- Golang · Go问答 | 6小时前 |
- Go httptrace.Wait100Continue 怎样定位客户端等待 100 Continue
- 146浏览 收藏
-
- Golang · Go问答 | 6小时前 |
- Go http.CrossOriginProtection.AddTrustedOrigin 怎样放行受信任来源
- 347浏览 收藏
-
- Golang · Go问答 | 6小时前 | 网络编程 · HTTP · Go问答 · Go HTTP代理 httputil ReverseProxy ModifyResponse
- Go httputil.ReverseProxy.ModifyResponse 怎样改写上游响应
- 288浏览 收藏
-
- Golang · Go问答 | 6小时前 |
- Go os.Root.Close 后为什么不能继续打开文件
- 182浏览 收藏
-
- Golang · Go问答 | 7小时前 |
- Go http.Client 跟随重定向时如何保留认证头
- 290浏览 收藏
-
- Golang · Go问答 | 7小时前 | ip地址 · Go问答 · Go CIDR net/netip Prefix.Masked 网段规范化
- Go netip.Prefix.Masked 怎样规范化带主机位的 CIDR
- 452浏览 收藏
-
- Golang · Go问答 | 7小时前 |
- Go token.File.LineCount 统计源码行数的边界与位置映射
- 294浏览 收藏
-
- Golang · Go问答 | 7小时前 | Go问答 · Go pkix.Name x509 Certificate.Subject 证书主体
- Go x509.Certificate.Subject 怎样读取证书主体信息
- 298浏览 收藏
-
- Golang · Go问答 | 7小时前 | 标准库 · 工程实践 · HTTP客户端 · Go问答 · Go net/http keep-alive HTTP连接 Request.Close
- Go http.Request.Close 怎样让客户端主动关闭 HTTP 连接
- 135浏览 收藏
-
- Golang · Go问答 | 7小时前 | DNS Go timeout errors.As net.DNSError Temporary
- Go net.DNSError 怎样区分 DNS 超时与临时错误
- 140浏览 收藏
-
- Golang · Go问答 | 7小时前 |
- Go os/exec.Cmd.Err 怎样判断命令在启动前就失败
- 125浏览 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 485次学习
-
- PubMedQA
- 深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
- 1084次使用
-
- H2O EvalGPT
- H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
- 1084次使用
-
- LMArena
- LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
- 1247次使用
-
- HELM
- 深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
- 1191次使用
-
- MMBench
- MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
- 1037次使用
-
- 用Nginx反向代理部署go写的网站。
- 2023-01-17 502浏览
-
- GoLand调式动态执行代码
- 2023-01-13 502浏览
-
- Go gosym.Sym.BaseName 怎样去掉符号的包名与接收者
- 2026-11-17 501浏览
-
- 正则命名捕获组取不到值怎么办
- 2026-11-15 501浏览
-
- Go pprof profile duration 参数如何理解
- 2026-11-14 501浏览

