code-documentation

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

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.

agentmods
npx agentmods add rules/hlalljie/agent-workflow-presets/code-documentation
Clone the repo
git clone --depth 1 https://github.com/hlalljie/agent-workflow-presets

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 138 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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 $0.00000 $0.00138
Opus 5 $0.00000 $0.00069
Sonnet 5 $0.00000 $0.00028
Haiku 4.5 $0.00000 $0.00014

Measured yesterday against content hash d5bc02f219a0, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, 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 yesterday.

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 · 16 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 with pointers to tasks.

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.

Function/component comments: only when there are meaningful constraints, failure modes, or side effects beyond what the name and types convey.

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. yesterday 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 1mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 138 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.