Godoc: documenting Go code
Explains how package structure and prose affect generated Go documentation quality.
Explains how package structure and prose affect generated Go documentation quality.
- Author: Andrew Gerrand
- Authority: primary
- Kind: blog
- URL: https://go.dev/blog/godoc
What it covers
- godoc expectations
- example-driven docs
- writing docs for browsable APIs
Why authoritative
Go blog explanation of how documentation tooling shapes API docs.
Use when
- how does this affect Go documentation output
- is this package documented well for godoc
- how should examples and comments support godoc
Keywords
- godoc, documentation, examples, package docs, API readability