golang-comments

What problem does it solve?

Go projects often struggle with inconsistent, hard-to-navigate documentation. This skill provides structured guidelines to ensure every exported symbol has a proper doc comment, and that references, headings, and formatting follow Go conventions.

Core Features & Use Cases

• Doc comment style guidance for packages, types, functions, methods, and variables.
• Correct use of doc links in Go comments using [Name] style references to enable navigation in pkg.go.dev.
• Clear rules for headings, lists, and code blocks to improve readability and consistency.
• Use Case: apply these rules when documenting a library or updating documentation across a Go codebase.

Quick Start

Apply these Go doc comment rules to a package to ensure clean, navigable, and consistent documentation.