Go Documentation

Go Documentation

Documentation in Go is part of the API. Doc comments compile into go doc, pkg.go.dev, and IDE tooltips, so the rules exist to make those views readable. Code says what; comments say why, when, and what can go wrong.

Core Rules

1. Every exported name has a doc comment. Packages, types, functions, methods, constants, variables.
2. Doc comments start with the name (// Encode writes ...). Full sentences, capitalised, end with a period.
3. Document non-obvious behaviour. Restating the signature is noise.
4. Mark deprecations explicitly with a Deprecated: paragraph.
5. Examples are tests — runnable Example* functions in _test.go files with // Output: blocks are verified by go test.
6. Every package has exactly one package comment above the package clause in one file (doc.go if long).

What Project Are You Documenting?

Detect this first — it changes the doc surface area.

Universal: doc comments on exported names, package comment, README, LICENSE, CONTRIBUTING (recommended), CHANGELOG (recommended).

Read references/godoc-grammar.md for the comment grammar, headings/lists, deprecation markers, and full examples.

Comment Grammar

// Encode writes the JSON encoding of req to w.
// It returns an error if req contains a non-serialisable field.
func Encode(w io.Writer, req *Request) error

Rules:

• Start with the name of the thing.
• Use a verb phrase for functions/methods, a noun phrase for types/values.
• Articles (A, An, The) may precede the name.
• Full sentences, punctuation included.
• Wrap at ~80 columns for diff comfort; no hard limit.

Unexported names with non-obvious behaviour should also be commented — those comments are for maintainers, not godoc.

What to Document

Restating signatures is the most common waste:

// Bad — restates what you can see
// SetName sets the name.
func (u *User) SetName(name string) { ... }

// Good — explains the why and the constraints
// SetName sets the user's display name. Returns ErrInvalidName
// if name is empty or longer than MaxNameLen.
func (u *User) SetName(name string) error { ... }

Package Comments

Every package has exactly one. Place it above the package clause in one file. For long descriptions, use a dedicated doc.go.

// Package store provides a transactional key-value store backed by
// SQLite. It is safe for concurrent use; see (*Store).BeginTx for
// transaction semantics.
package store

For main packages, use the binary name:

// The migrate command applies SQL migrations from disk to a database.
package main

Runnable Examples

func ExampleEncode() {
    var buf bytes.Buffer
    _ = Encode(&buf, &Request{ID: "abc"})
    fmt.Println(buf.String())
    // Output: {"id":"abc"}
}

Naming:

• func Example() — package-level example.
• func ExampleFoo() — example for Foo.
• func ExampleFoo_bar() — alternate example for Foo titled "bar".
• func ExampleT_Method() — example for T.Method.

go test runs these and verifies the // Output: line matches. They appear in godoc attached to the named symbol — the best documentation is the kind the compiler keeps honest.

Read references/examples-and-readme.md for Example* patterns, the canonical README outline, and CONTRIBUTING/CHANGELOG templates.

Error and Type Docs

Sentinel errors: document on the variable, not on each return.

// ErrNotFound is returned when no record matches the query.
var ErrNotFound = errors.New("store: not found")

Error types: document with the pointer form so errors.Is/errors.As examples match.

// PathError records the operation and path that caused an error.
// Use errors.As(err, new(*PathError)) to inspect the fields.
type PathError struct { Op, Path string; Err error }

Anti-Patterns

Verification Checklist

• go doc ./... renders cleanly for every package (no missing doc warnings from linters).
• Every exported identifier has a comment starting with its name.
• Every package has exactly one package comment.
• All deprecations include the Deprecated: paragraph.
• At least one Example* test per non-trivial exported function in a library package.
• README contains: title, summary, install, minimal working example, license.
• golangci-lint run --enable=godot,revive passes (revive's exported rule).

Enforce With Linters

Mechanical checks belong to CI:

• revive exported — missing doc comments on exported names.
• godot — missing trailing periods in doc comments.
• misspell — typos in comments.
• go vet — basic format-string and other issues that also surface in docs.

References

• references/godoc-grammar.md — sentence rules, headings, deprecation, formatting
• references/examples-and-readme.md — Example* tests, README outline, CONTRIBUTING/CHANGELOG
• references/library-vs-application.md — what each project type needs, llms.txt, CLI --help