code-documentation

code-documentation is a cursor rule for Cursor from hlalljie/agent-workflow-presets. It costs 0 tokens per session (327 once invoked), scanned A, original, MIT.

A set of rules for writing useful comments and documentation in code. It focuses on explaining purpose, limits, trade-offs, unusual decisions, and known technical debt rather than repeating obvious code.

In plain words
What is it for?
Use it when adding or reviewing comments, docstrings, module notes, and component documentation.
Why use it?
It keeps comments from becoming clutter while preserving information that future developers cannot easily infer from the code itself.

Cursor rule for Cursor

Written for Cursor: installed under .cursor/.

Good fit Use it when adding or reviewing comments, docstrings, module notes, and component documentation.

Compare 6 cursor rules from other repositories ↓
Install with agentmods
npx agentmods add rules/hlalljie/agent-workflow-presets/code-documentation
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.

Clone the repo
git clone --depth 1 https://github.com/hlalljie/agent-workflow-presets

Made for: Cursor.

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 code-documentation

README.md
[![agentmods](https://agentmods.dev/badge/rules/hlalljie/agent-workflow-presets/code-documentation/github.svg)](https://agentmods.dev/rules/hlalljie/agent-workflow-presets/code-documentation)
Your own site
<a href="https://agentmods.dev/rules/hlalljie/agent-workflow-presets/code-documentation"><img src="https://agentmods.dev/badge/rules/hlalljie/agent-workflow-presets/code-documentation/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 code-documentation

Your own site · 80×15
<a href="https://agentmods.dev/rules/hlalljie/agent-workflow-presets/code-documentation"><img src="https://agentmods.dev/badge/rules/hlalljie/agent-workflow-presets/code-documentation.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 327 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.
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.00000 $0.00327
Opus 5.5 $0.00000 $0.00131
Sonnet 5.5 $0.00000 $0.00065
Haiku 4.5 $0.00000 $0.00033

Measured 6d ago against content hash 5c288c54d116, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

code-documentation 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 6d 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.

.cursor/rules/code-documentation.mdc · 30 lines

What it actually says

Document why, not what. Only add a comment if it conveys information the code itself cannot. Never narrate what the code obviously does.

Do document: purpose, constraints, trade-offs, non-obvious decisions, known debt (see TODOs below).

Do not document: obvious logic, simple wrappers, self-evident one-liners.

Module/file-level comments: explain what the module owns and any non-obvious limitations.

Comment kinds

  • /** */ doc comment — the contract of an exported symbol, only when its name and types do not already say it: units, edge cases, side effects, failure modes. Write TSDoc style: no types in tags, @param name - description with the hyphen, and only tags that add information (@throws, @deprecated plus what to use instead, @example).
  • // comment — why the implementation is the way it is.

TODOs

TODO(#123): reason, pointing at the GitHub issue that tracks it. With no issue, write TODO: reason and no link. Never point at a plan or task file, because plans move (see workflow.mdc).

Do not write

  • Comments that narrate the change ("now uses X", "added for Y")
  • Banner or divider comments
  • Comments that restate a name or type
  • Edits to comments unrelated to the change
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. 6d ago Changed · +14 lines 5c288c54d116
  2. 1mo ago First seen · 16 lines · 0 tokens per session scan A d5bc02f219a0

Subscribe to this mod's changes

code-documentation is a cursor rule published in the GitHub repository hlalljie/agent-workflow-presets (2 stars, last pushed 7d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 327 tokens. 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-31.