java-comments

A Java comment-style rule for .java files. It requires // for single-line comments and /// for documentation or multi-line comments, with documentation written in English and Markdown when needed.

In plain words
What is it for?
Use it when writing or reviewing Java comments, API documentation, parameters, return descriptions, and formatted notes.
Why use it?
It keeps comments consistent and avoids forbidden traditional Javadoc block comments.

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/sunmh207/entire-dashboard/java-comments
Clone the repo
git clone --depth 1 https://github.com/sunmh207/entire-dashboard

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 264 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.00264
Opus 5 $0.00000 $0.00132
Sonnet 5 $0.00000 $0.00053
Haiku 4.5 $0.00000 $0.00026

Measured yesterday against content hash df303041988f, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

java-comments 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.

server/.cursor/rules/java-comments.mdc · 65 lines

What it actually says

Java Comment Style

Scope

All .java files.

Rules

  1. Single-line comments must use //.

  2. Documentation or multi-line comments must use ///.

  3. Do NOT use traditional Javadoc block comments (/** ... */).

  4. Each line of a documentation comment must start with ///.

  5. Comments should preferably be written in English.

  6. For long documentation comments that require formatting, use Markdown syntax. Do not use HTML tags inside comments.

Examples

Single-line comment

// Calculate total price int total = price * count;

Documentation comment

/// Returns the user by ID /// /// @param id user identifier /// @return user entity User getUser(Long id);

Documentation comment with Markdown

/// Returns repository information /// /// Features /// - Supports pagination /// - Supports filtering /// - Supports sorting /// /// @param query search query /// @return paginated result

Forbidden style

/**

  • Returns the user by ID */ User getUser(Long id);

Forbidden formatting

/// Repository information /// /// Pagination /// Filtering ///

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 · 65 lines · 264 tokens per session scan A df303041988f

Subscribe to this mod's changes

java-comments is a cursor rule published in the GitHub repository sunmh207/entire-dashboard (24 stars, last pushed 2mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 264 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-30.