Craft Go doc comments with [Name] links and standard formatting.
npx skills add https://github.com/nieomylnieja/dotfiles --skill golang-comments
Please help me install this Agent Skill. Skill: golang-comments Source: https://github.com/nieomylnieja/dotfiles/tree/main/config/agents/skills/golang-comments Command: npx skills add https://github.com/nieomylnieja/dotfiles --skill golang-comments
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.
Apply these Go doc comment rules to a package to ensure clean, navigable, and consistent documentation.
High-intent search queries and answers about installing and using this skill.
Navigable Go doc comments require proper syntax using [Name] style references to enable documentation navigation on pkg.go.dev. Structured guidelines ensure exported functions, methods, and types have consistent formatting and compliant references.
Correct doc links in Go documentation use [Name] style references to create navigable connections between packages, types, and functions. This syntax ensures references resolve correctly on pkg.go.dev.
Formatting headings and code blocks in Go doc comments requires following specific style-guide rules for lists and references. Clear formatting rules improve readability and maintain consistency across a library codebase.
Yes, every exported symbol in a Go package needs a doc comment. Structured guidelines ensure exported variables, types, and functions have proper documentation that follows Go conventions.
The best way to ensure consistent documentation across a Go codebase is applying structured style-guide rules for doc comments. This enforces proper formatting, correct link syntax, and clear headings across packages.
Go package comments fail to generate links on pkg.go.dev when they lack correct [Name] style doc link syntax. Applying proper documentation conventions resolves navigation issues and ensures references resolve.
easyspace-aiAdd missing documentation comments to exported Go symbols.
rigercWrite Go doc comments for exported packages, types, functions, and variables.
zajcaConfigure golangci-lint with recommended Go linters for static analysis.
brandon-fryslieGenerate Markdown documentation specifications from source code.
