终结十年纠结:Go 新提案允许 Example 支持任意函数签名

本文永久链接 – https://tonybai.com/2026/06/09/go-proposal-examples-to-support-arbitrary-function-signatures 大家好,我是Tony Bai。 在 Go 语言的开发日常中,编写 ExampleXxx 示例代码不仅是完善文档的必经之路,更是一门绝佳的“活文档”艺术。 通过在 “_test.go” 文件中编写以 Example 开头的函数,并在末尾加上 // Output: 注释,Go 官方的 go doc 和 pkgsite 就能在网页上直接渲染出可交互、可直接在浏览器中运行(Playable)的示例代码。 ...

June 9, 2026 · 6 min · Tony Bai

重拾精髓:go doc -http让离线包文档浏览更便捷

重拾精髓:go doc -http让离线包文档浏览更便捷 | Tony Bai Tony Bai一个程序员的心路历程 Google Go语言编码风格规范 Google Go语言编码风格规范:指南篇 Google Go语言编码风格规范:决定篇 Google Go语言编码风格规范:最佳实践篇 Go语言第一课FAQ 关于我 文章列表 重拾精髓:go doc -http让离线包文档浏览更便捷 九月 6, 2024 0 条评论 ...

September 6, 2024 · 5 min · Tony Bai

聊聊godoc、go doc与pkgsite

本文永久链接 – https://tonybai.com/2023/03/20/godoc-vs-go-doc-vs-pkgsite 就像上一篇文章聊到的Go内置单元测试框架一样,既重视语言特性,又不忘对Go软件项目提供整体环境特性的Go在诞生伊始就定义了如何在源码中通过注释编写代码文档的格式,并提供了基于代码注释实时生成Go文档并支持文档查看的工具。 而一些早期的语言,比如C、C++等则需要使用第三方工具(如doxygen)以及这些工具规定的特定格式编写文档,缺少语言原生的文档标准与工具,给后期开发人员之间的协作带去了麻烦。 查看文档是开发人员日常必不可少的开发活动之一。Go语言从诞生那天起就十分重视项目文档的建设,为此Go为gopher们提供了多种丰富的文档查看工具,除了在Go官方网站可以在线查看到最新稳定发布版的文档之外,Go还为开发人员提供了本地离线查看文档的工具,比如:godoc、go doc以及pkgsite。在这篇短文中,我们就来分别看看这三个Go文档查看工具。 ...

March 20, 2023 · 10 min · Tony Bai

如何查看历史版本的Go文档?嘘!答案我只告诉你!

Go语言自开源至今已经11个年头了!截至本文发稿时,目前最新的Go版本为1.15,Go核心开发团队正紧锣密鼓的进行着Go 1.16版本的开发(现阶段主要是修复bug),该版本将在2021年2月份正式发布。 Go以“自带电池(battery included)”而为人所知,除了Go标准库的全面和强大之外,Go工具链的丰富和易用在主流编程语言中也是位列“执牛耳者”之列的,而Go文档查看工具就在Go工具链之列中。 ...

December 15, 2020 · 6 min · Tony Bai