01Go-engineeringOct 26, 2026

文档写作规范:注释、README 与 CHANGELOG

Go 的注释与文档是同一来源:godoc 与 pkg.go.dev 直接把源码中的文档注释(doc comment)渲染为 API 文档站,不存在 Javadoc 那样"文档一套、注释一套"的双轨维护。由此可得一个直接推论:评价一个库"文档差",基本等同于评价它的注释差——注释之外没有第二个文档来源。

11 min read

Quote of the day · November 15关于接受Breaking Bad

You got the job. Do yourself a favor and learn to take yes for an answer.