Go Documentation

Go Documentation

Resource Routing

• scripts/check-docs.sh - Run when checking exported functions, types, methods, constants, and packages for missing doc comments.
• scripts/check-docs-ast.go - Implementation helper invoked by check-docs.sh; patch this when changing documentation analysis behavior.
• assets/doc-template.go - Use when starting a documented package or exported API.
• references/CONVENTIONS.md - Read when documenting parameters, context behavior, concurrency safety, cleanup, errors, or named results.
• references/EXAMPLES.md - Read when adding runnable examples or package examples.
• references/FORMATTING.md - Read when formatting Godoc lists, paragraphs, links, and code blocks.

---

Doc Comments

Normative: All top-level exported names must have doc comments.

Basic Rules

1. Begin with the name of the object being described
2. An article ("a", "an", "the") may precede the name
3. Use full sentences (capitalized, punctuated)

// A Request represents a request to run a command.
type Request struct { ...

// Encode writes the JSON encoding of req to w.
func Encode(w io.Writer, req *Request) { ...