Claude Code Skills·Claude Skills·The open SKILL.md registry for Claude
ClaudSkills / Engineering / docs-engineering

Comment Conventions

Category: Engineering  ·  Sub-category: docs-engineering  ·  Last updated:
lang:kotlin
Language-agnostic code commenting and docblock conventions. Trigger on every source-code Edit/Write in any language (JS/TS, Python, PHP, Ruby, Go, Rust, Java, Kotlin, Swift, C/C++, C#, Elixir, Lua, Shell, etc.) — even when the user has not mentioned comments, docblocks, JSDoc/TSDoc/PHPDoc, docstrings, or documentation. Governs every comment authored or modified, every new function/method/class/component (which must get a compliant docblock), every inline comment (which must stay terse — no prose walls, no business-logic essays, no "step 1 / step 2" narration in the code path), and any non-compliant docblock encountered in the file being edited (which must be fixed in place — no need to ask first, except when the existing docblock is unusually long and clearly intentional, in which case leave it alone). Apply to all code authoring across all languages, every time source code is touched. When in doubt whether this skill applies to a code edit, invoke it. Skip only for non-code files (JSON/YAML/TOML configs, markdown, lockfiles) or trivial one-character edits.
Security AStatic scan found no risk patternsHow grading works ›

From the source SKILL.md

Language-agnostic rules for writing code comments and docblocks. They apply to any language and any comment syntax — inline //, block / /, JSDoc, TSDoc, PHPDoc, Python docstrings, Rustdoc ///, GoDoc, KDoc, Elixir @doc, Ruby YARD, etc.

What this skill does

Comment Conventions is a community-contributed Claude Code skill in the docs-engineering sub-category. It ships as a SKILL.md file that Claude Code auto-discovers under ~/.claude/skills/comment-conventions/ and loads when your prompt matches the skill's trigger.

Who uses this skill

The Comment Conventions Claude Code skill is built for software engineers, backend developers, full-stack teams, and technical leads building and maintaining production systems. It's part of ClaudSkills (also referred to as Claude Skills or Claude Code Skills) — the open community-curated registry of 190,000+ SKILL.md files for Anthropic's Claude Code agent and the wider Claude ecosystem (Claude API, Claude Agent SDK).

How to install

Free

Manual install (2 steps)

mkdir -p ~/.claude/skills/comment-conventions
curl -L https://claudskills.com/skills/comment-conventions/SKILL.md \
  -o ~/.claude/skills/comment-conventions/SKILL.md

Or just download SKILL.md directly and drop it into ~/.claude/skills/comment-conventions/. Claude Code auto-discovers it on next session.

Skills live at ~/.claude/skills/comment-conventions/SKILL.md on macOS/Linux, or %USERPROFILE%\.claude\skills\comment-conventions\SKILL.md on Windows. See the full install guide for step-by-step instructions.

Telegram

📱 Install from your phone or desktop Telegram

Open @claudskills_bot on Telegram, tap Open Desktop App, and the desktop app installs this skill for you. Or share the bot link with a colleague — they get the same one-tap install. Learn more →

Pro

One-click install via the desktop app

The ClaudSkills desktop app installs any skill directly into ~/.claude/skills/ with one click — no terminal required. Pro starts at $9/mo or $149 lifetime.

Pro

For the full experience including quality scoring and one-click install features for each skill — upgrade to Pro.

Frequently asked questions

How do I install the Comment Conventions Claude Code skill?
Install via the ClaudSkills desktop app (one click) or copy SKILL.md from the source repository to ~/.claude/skills/comment-conventions/SKILL.md and restart Claude Code. Both flows are detailed at claudskills.com/install/.
What does the Comment Conventions skill do?
Language-agnostic code commenting and docblock conventions. Trigger on every source-code Edit/Write in any language (JS/TS, Python, PHP, Ruby, Go, Rust, Java, Kotlin, Swift, C/C++, C#, Elixir, Lua, Shell, etc.) — even when the user has not mentioned comments, docblocks, JSDoc/TSDoc/PHPDoc, docstrings, or documentation. Governs every comment authored or modified, every new function/method/class/component (which must get a compliant docblock), every inline comment (which must stay terse — no prose walls, no business-logic essays, no "step 1 / step 2" narration in the code path), and any non-compliant docblock encountered in the file being edited (which must be fixed in place — no need to ask first, except when the existing docblock is unusually long and clearly intentional, in which case leave it alone). Apply to all code authoring across all languages, every time source code is touched. When in doubt whether this skill applies to a code edit, invoke it. Skip only for non-code files (JSON/YAML/TOML configs, markdown, lockfiles) or trivial one-character edits.
Is this skill free to install?
Yes. ClaudSkills is an open registry — every skill keeps its source repository's license, and manual install via copy is free. ClaudSkills Pro ($9/mo, $79/yr, or $149 one-time) adds one-click install via the desktop app and a multi-signal Quality Score.
When should I use the Comment Conventions skill?
Use Comment Conventions when your Claude Code task falls under the Engineering category — specifically in the docs engineering area. Claude Code auto-discovers installed skills and invokes the right one based on the task description, so you can also ask Claude directly (e.g. "use Comment Conventions" or describe the task and let Claude pick). Browse related skills at /category/engineering/.
What is a Claude Code skill and how does the Comment Conventions skill fit in?
A Claude Code skill is a SKILL.md file that lives under ~/.claude/skills/<name>/ and tells the Claude Code CLI agent how to perform a specific task (instructions, prompts, allowed tools). Skills are auto-discovered at session start. Comment Conventions is one of 67,000+ skills indexed in the open ClaudSkills catalog, classified under the Engineering category. Learn more at /learn/what-is-a-claude-skill/.

Attribution & license

Cite this skill

If you reference this skill in a blog post, paper, or documentation, you can cite it as:

APA
rvanbaalen. (2026). Comment Conventions [Claude Code skill]. ClaudSkills. https://claudskills.com/skills/comment-conventions/
BibTeX
@misc{comment-conventions-2026,
  author    = {rvanbaalen},
  title     = {Comment Conventions [Claude Code skill]},
  year      = {2026},
  publisher = {ClaudSkills},
  url       = {https://claudskills.com/skills/comment-conventions/}
}

Embed this skill

Promote, attribute, or link this skill from your own README, blog post, or documentation. All three snippets are free to use — no sign-up, no API key. More distribution surfaces →

Badge
[![ClaudSkills](https://claudskills.com/badge/comment-conventions.svg)](https://claudskills.com/skills/comment-conventions/?utm_source=badge&utm_medium=readme&utm_campaign=skill_badge)
<script>
<script src="https://claudskills.com/embed/comment-conventions.js" async></script>
<iframe>
<iframe src="https://claudskills.com/embed/comment-conventions.html" width="100%" height="160" frameborder="0" loading="lazy" title="ClaudSkills: Comment Conventions"></iframe>

Security scan

Grade A · scanned 2026-08-24 — free static scan against the OWASP Agentic Skills Top 10.

No risk patterns were found in any of the ten OWASP-aligned categories. How grading works ›

Show this grade on your repo (click to copy):

[![Security: A](https://img.shields.io/badge/Security-A-2e7d32)](https://claudskills.com/skills/comment-conventions/#security)

Free. No spam. Unsubscribe in one click.

More Engineering skills

Browse all Engineering skills in the ClaudSkills registry, or explore these other picks from the same category:

Browse all Engineering skills → Top 100 skills
Part of ClaudSkills — the open registry for Claude Skills & Claude Code Skills.  ·  What's New  ·  Install guide  ·  About  ·  llms.txt

Part of Acreator Store — Adam Lankamer's AI tools: PerfectStudio · Ucaption · UTagger · AutoXPoster · TestYourSkills · AutomationFlows · Au Naturel · Telegram @acreatorstore