002-code-style

A set of Chinese-language coding style rules covering naming, formatting, comments, and common conventions for JavaScript, Python, Java, and C#.

In plain words
What is it for?
Use it when reviewing or writing code, choosing names, formatting files, writing comments, or deciding when existing project or framework conventions should take priority.
Why use it?
It gives a shared standard for readable and consistent code across languages and helps teams avoid conflicting styles.

Cursor rule

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/haidong-once/cursor-rules-collection/002-code-style
Clone the repo
git clone --depth 1 https://github.com/HaiDong-Once/cursor-rules-collection
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 625 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.00625
Opus 5 $0.00000 $0.00313
Sonnet 5 $0.00000 $0.00125
Haiku 4.5 $0.00000 $0.00063

Measured 2d ago against content hash 124523a34261, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

002-code-style 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 2d 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.

core/002-code-style.mdc · 80 lines

What it actually says

代码风格规则 (002)

规则概述

本规则定义了跨语言通用的代码风格指南,旨在提高代码可读性、一致性和可维护性。

命名约定

1.1 通用命名原则

  • 名称应当清晰表达其用途和意图
  • 避免使用缩写,除非是广泛接受的(如 ID, HTML, URL)
  • 避免使用单字母变量名,除非作为循环索引或临时变量

1.2 特定语言命名规范

语言 变量/属性 函数/方法 类/接口 常量
JavaScript camelCase camelCase PascalCase UPPER_SNAKE_CASE
Python snake_case snake_case PascalCase UPPER_SNAKE_CASE
Java camelCase camelCase PascalCase UPPER_SNAKE_CASE
C# camelCase PascalCase PascalCase PascalCase

格式化

2.1 缩进

  • 使用空格而非制表符(Tab)
  • 缩进宽度为2或4个空格(项目内保持一致)

2.2 行长度

  • 每行代码不超过80-100个字符
  • 较长的语句应当在逗号或操作符后换行

2.3 空行

  • 使用空行分隔逻辑相关的代码块
  • 类/函数定义之间使用1-2个空行
  • 相关的导入语句之间不需要空行

注释

3.1 注释语法

  • 使用语言标准的注释语法
  • 所有多行注释都应以语言的多行注释标记开始

3.2 注释内容

  • 注释应解释"为什么",而不是"做了什么"
  • 复杂算法或非直观逻辑需要详细注释
  • 使用TODO、FIXME等标准标记注释未完成的工作

语言特定规则

[更多详细的特定语言规则可以参考其他规则:]

代码检查工具

推荐使用以下工具确保代码风格一致性:

  • ESLint (JavaScript)
  • Prettier (多语言格式化)
  • black (Python)
  • checkstyle (Java)

异常与例外

在某些特定情况下,可以偏离这些规则:

  1. 维护旧项目时,应遵循项目已有风格
  2. 使用特定框架时,应遵循框架推荐风格
  3. 针对性能优化的关键代码可适当降低可读性要求
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. 2d ago First seen · 80 lines · 0 tokens per session scan A 124523a34261

Subscribe to this mod's changes

002-code-style is a cursor rule published in the GitHub repository HaiDong-Once/cursor-rules-collection (24 stars, last pushed 1y ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 625 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.