skills.rest
xiaolai
xiaolaiCOMMUNITY
Explore all skills by this author →
Website𝕏@xiaolaiGitHub

lang-go

Detect exported identifiers in Go code and enforce godoc-compliant comments for public APIs.

6|Updated Feb 28, 2026
Search Tags:#documentation#api#go#static-analysis#lint#godoc#exported
One-click install
npx skills add https://github.com/xiaolai/docs-guardian-for-claude --skill lang-go-xiaolai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: lang-go
Source: https://github.com/xiaolai/docs-guardian-for-claude/tree/main/skills/docs-guardian/languages/go
Command: npx skills add https://github.com/xiaolai/docs-guardian-for-claude --skill lang-go-xiaolai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams ensure that Go codebases expose only intended public APIs and that exported symbols are documented with properly formed godoc comments.

Core Features & Use Cases

  • Detect exported identifiers in Go source (types, functions, variables, constants) and verify they are documented.
  • Enforce godoc comment conventions: comments must start with the symbol name and form complete sentences.
  • Skip internal code and generated/test files to maintain focus on public API surface.

Quick Start

Run the adapter on a Go project to verify public API visibility and godoc compliance across the codebase.

Frequently Asked Questions about lang-go

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce godoc comments for exported Go symbols?▼

To enforce godoc comments for exported Go symbols, you need a tool that detects exported identifiers and verifies each comment starts with the symbol name and forms a complete sentence. This validates your public API documentation automatically.

What is the best way to detect undocumented public APIs in a Go project?▼

Detecting undocumented public APIs in a Go project requires scanning source code for exported types, functions, variables, and constants. The process identifies missing godoc comments across all packages while skipping internal, test, and generated files to focus on the public API surface.

Does godoc compliance checking apply to internal and test Go files?▼

No, godoc compliance checking does not apply to internal and test Go files. The detection process explicitly skips internal code, test files, and generated code to focus solely on the public API surface and documentation quality of exported symbols.

Why does my Go codebase expose unintended public APIs?▼

Your Go codebase exposes unintended public APIs when exported identifiers lack proper documentation. Detecting these exported symbols and enforcing godoc-compliant comments helps teams ensure only intended public APIs are visible and properly documented.

Related Skills

Explore More Software Engineering Skills→
vlad-ryzhkovvlad-ryzhkov
25

repo-scout

Audit Go backend repositories for API endpoints, infrastructure, and test coverage.

Community
Intermediate
cxuucxuu
139

go-documentation

Standardize Go doc comments, package docs, and godoc formatting.

Community
Advanced
lazygopherslazygophers
4

lint

Configure and execute golangci-lint for Go projects with custom linters and exclusions.

Official
Intermediate
easyspace-aieasyspace-ai

add-code-comments

Add missing documentation comments to exported Go symbols.

Community
Intermediate