comment

comment is a skill for Claude Code from Kevin-Liu-01/Agent-Machines. It costs 42 tokens per session (3,186 once invoked), scanned A, original, MIT.

A documentation and commenting guide for Rust, Python, Go, and TypeScript code. It explains when comments add useful information and how to write them according to project conventions.

In plain words
What is it for?
Use it when writing module documentation, doc comments, or inline comments in supported languages, especially in projects with shared style guides.
Why use it?
Comments that merely repeat the code become noise, while missing context makes code harder to understand. The guide helps keep documentation useful for both new and experienced readers.

Skill for Claude Code

Written for Claude Code: allowed-tools in frontmatter.

Good fit Use it when writing module documentation, doc comments, or inline comments in supported languages, especially in projects with shared style guides.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/kevin-liu-01/agent-machines/comment
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add Kevin-Liu-01/Agent-Machines --skill comment
Clone the repo
git clone --depth 1 https://github.com/Kevin-Liu-01/Agent-Machines

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for comment

README.md
[![agentmods](https://agentmods.dev/badge/skills/kevin-liu-01/agent-machines/comment/github.svg)](https://agentmods.dev/skills/kevin-liu-01/agent-machines/comment)
Your own site
<a href="https://agentmods.dev/skills/kevin-liu-01/agent-machines/comment"><img src="https://agentmods.dev/badge/skills/kevin-liu-01/agent-machines/comment/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for comment

Your own site · 80×15
<a href="https://agentmods.dev/skills/kevin-liu-01/agent-machines/comment"><img src="https://agentmods.dev/badge/skills/kevin-liu-01/agent-machines/comment.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 42 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,186 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe. Third-party audits
  • NVIDIA SkillSpector pass 7 Sept 2026
How audits are shown
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00042 $0.03186
Opus 5.5 $0.00017 $0.01274
Sonnet 5.5 $0.00008 $0.00637
Haiku 4.5 $0.00004 $0.00319

Measured 1mo ago against content hash c9d701d7ef38, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

comment scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

knowledge/skills/comment/SKILL.md · 386 lines

How it starts

The opening of the file, as written. The whole thing — 386 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Comment Style

One principle across all languages: comments state what IS. They never narrate what is happening, restate what the code says, or editorialize.

The deletion test: if the comment disappears, does the reader lose information they could not get from reading the code? If no, delete it.

Style guides to load

Read the relevant guide before making comment/doc decisions. These are the canonical sources; do not rely on memory of their contents.

Language Guide path
Root (all languages) style/style.md
Python docs/src/style/python.mdx — see ## Documentation section
TypeScript style/typescript.md
Rust docs/src/style/rust.mdx
Go (guide) docs/src/style/go/guide.mdx
Go (decisions) docs/src/style/go/decisions.mdx — see documentation section

Read style/style.md always. Then read the language-specific guide for the file you are editing.


Cardinal rule: write for the least experienced reader

Code and comments should be immediately understandable by both a novice and an expert. A reader should never have to leave the file to figure out what the file does or why it exists.

This is the bar: if someone opens this file cold, with no prior context about the project, can they answer these questions within 30 seconds?

  1. What does this module do?
  2. Why does it exist?
  3. Where does it fit in the system?

If the answer requires reading five other files, the module doc has failed.

Short sentences, plain words

MOST IMPORTANT RULE: write like a sixth grader. One idea per sentence. No subordinate clauses when two sentences will do.

Bad:  "The guest kernel sends FUSE requests over virtio-fs, a virtio
      device that carries FUSE operations over shared memory instead
      of a network socket, and fuse-backend-rs deserializes them and
      calls our FileSystem trait impl."

Good: "The guest kernel sends FUSE requests over virtio-fs. virtio-fs
      uses shared memory, not network packets. fuse-backend-rs
      deserializes the requests. We answer them."

Read the full file on GitHub · 386 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 1mo ago First seen · 386 lines · 42 tokens per session scan A c9d701d7ef38

Subscribe to this mod's changes

comment is a skill published in the GitHub repository Kevin-Liu-01/Agent-Machines (30 stars, last pushed 3d ago), licensed MIT. It adds 42 tokens to every session and 3,186 once invoked, about $0.0002 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.