godoc-comments

What problem does it solve?

Go projects often lack cohesive, correctly formatted documentation for packages, types, functions, and variables, which hinders understanding and maintenance.

Core Features & Use Cases

• Provides guidance on writing Go doc comments that render correctly in go doc, pkg.go.dev, and IDEs.
• Covers naming conventions, syntax (headings, links, lists, code blocks), and common mistakes to reduce documentation errors.
• Useful during code reviews or refactors to ensure exported identifiers have proper, consistent documentation.

Quick Start

Start by adding a package comment above each package declaration and follow the guidelines to document types and functions accordingly.