Go Doc Comments

Overview

Produce doc comments that render cleanly in go doc, pkgsite, and IDEs by following the Go project's official guidance. Apply this skill whenever documenting exported Go identifiers or packages.

When to Use

• Document exported Go packages, commands, types, funcs, consts, or vars.
• Review existing comments for compliance during code review or refactors.
• Convert informal inline comments into doc comments intended for pkgsite.

Avoid invoking this skill for unexported identifiers unless the repository mandates internal documentation parity.

Workflow

1. Locate the target declaration
   Place the comment immediately above the top-level declaration with no blank lines between the comment and the declaration.