Write Go doc comments for exported packages, types, functions, and variables.
npx skills add https://github.com/rigerc/flattenfetch --skill godoc-comments
Please help me install this Agent Skill. Skill: godoc-comments Source: https://github.com/rigerc/flattenfetch/tree/main/.agents/skills/godoc-comments Command: npx skills add https://github.com/rigerc/flattenfetch --skill godoc-comments
Go projects often lack cohesive, correctly formatted documentation for packages, types, functions, and variables, which hinders understanding and maintenance.
Start by adding a package comment above each package declaration and follow the guidelines to document types and functions accordingly.
High-intent search queries and answers about installing and using this skill.
To write Go doc comments that render correctly on pkg.go.dev, apply standard syntax rules for headings, links, lists, and code blocks above exported names and package declarations. This ensures proper rendering across go doc, pkg.go.dev, and IDEs.
Correct godoc syntax requires specific formatting for headings, links, lists, and code blocks to ensure proper rendering. Following these standard comment guidelines for exported identifiers prevents documentation errors and display inconsistencies across tools.
Yes, you need to document all exported names in a Go package. Adding clear, complete doc comments to packages, types, functions, and variables ensures cohesive project documentation and reduces maintenance issues during code reviews or refactoring.
To add a package comment in Go, place the comment directly above the package declaration. Follow standard godoc guidelines to ensure the package overview renders correctly in go doc, pkg.go.dev, and your IDE.
Common Go documentation mistakes include incorrect syntax for headings, links, lists, and code blocks. Applying standard godoc comment guidelines across exported names reduces these documentation errors and ensures consistent rendering across platforms.
Go doc comments use a specific syntax for headings, links, lists, and code blocks rather than standard markdown. Following the correct godoc formatting practices ensures your documentation renders properly in go doc, pkg.go.dev, and IDEs.
pure-golangEnforce doc.go contracts and Russian doc-comments for exported Go symbols.
rondevzEnforce Go documentation best practices across packages, types, and functions.
oioio-spaceEnforce Google's Go style guides with golangci-lint and gofmt.
tamago0224Generate structured software documentation in markdown using the Diátaxis framework.
