Guides writing and reviewing code comments in C, Go, Rust, and Zig.
npx skills add https://github.com/kohdice/dotfiles --skill comment-patterns-kohdice
Please help me install this Agent Skill. Skill: comment-patterns Source: https://github.com/kohdice/dotfiles/tree/main/config/agents/skills/comment-patterns Command: npx skills add https://github.com/kohdice/dotfiles --skill comment-patterns-kohdice
/// sections and safety justifications, Zig //////! style, and C project conventions without double-covering sibling idiom skills. - Use Case: While reviewing a Rust pull request, use this Skill to flag a stale doc comment whose contract contradicts the implementation, delete a redundant inline comment, and propose a why-not comment for a non-obvious workaround. ## Quick Start Review the comments in this Go file and flag any that are redundant, misleading, or misplaced according to the comment-patterns policy.High-intent search queries and answers about installing and using this skill.
A comment earns its keep when it carries local knowledge the code cannot express, such as a rejected alternative, an unenforceable constraint, or a relevant external reference. If it merely restates the adjacent code, delete it rather than rewriting it.
Judge each language by its own conventions: Go doc comments per go.dev/doc/comment, Rust `///` sections including Safety and Errors, and Zig `///`/`//!` per the Zig Style Guide. Machine-read directives like `//go:build` are code and should never be flagged.
Commits own why the change was made: motivation, tradeoffs, and history. Comments own why-not knowledge that prevents a future incorrect edit, such as why a simpler alternative fails or why an ordering constraint must hold.
Never flag comments mandated by language idioms, such as Go doc comments on exported symbols, Rust safety justifications on unsafe blocks, or deprecation markers. Machine-read comments like build tags and lint suppressions are also exempt.
Comments rot silently and mislead readers with authority, making misleading comments the most severe defect class. When changing code, updating or deleting every comment whose claim the change touches is part of the change itself.
PostHogReviews and rewrites code comments to explain why rather than restate what the code does.
sato-dev1234Flag comments revealing design rationale, LLM traces, or redundant explanations during code reviews.
roach88Generate standards-compliant documentation for source code files across multiple programming languages.
encero-systemsReview Rust prose comments and rustdoc accuracy with slice reports.