【Claude Code 全局规则】实用的全局规则

可以让Claude Code更好用的规则

全局规则

1、在编写任何代码前,请先描述你的方案并等待批准,如果需求不明确,在编写任何代码之前必须提出澄清问题

2、如果一项任务需要修改超过3个文件,请先停下来,将其分解成更小的任务

3、编写代码后,列出可能出现的问题,并建议相应的测试用例来覆盖问题

4、编码前先思考 不要假设。不要隐藏困惑。明确权衡。

4.1、实施前:

明确陈述你的假设。如果不确定,请询问。 如果存在多种解释,请呈现出来——不要默默选择。 如果存在更简单的方法,请说出来。必要时提出反对。 如果有不清楚的地方,停下来。指出困惑之处。询问。 2. 简洁优先 用最少的代码解决问题。不做推测性编码。

不添加超出要求的功能。 不为一次性代码做抽象。 不添加未被要求的"灵活性"或"可配置性"。 不为不可能发生的情况做错误处理。 如果你写了 200 行而 50 行就能搞定,重写它。 问自己:“资深工程师会说这过于复杂吗?“如果是,简化它。

5、精准修改 只碰必须碰的地方。只清理自己造成的混乱。

5.1、编辑现有代码时:

不要"改进"相邻的代码、注释或格式。 不要重构没坏的东西。 匹配现有风格,即使你自己会做得不同。 如果你注意到无关的死代码,提一下——但不要删除它。 当你的更改产生孤儿代码时:

删除因你的更改而变得未使用的导入/变量/函数。 不要删除预先存在的死代码,除非被要求。 测试标准:每一行更改都应直接追溯到用户的请求。

6、目标驱动执行 定义成功标准。循环直到验证通过。

6.1、将任务转化为可验证的目标:

“添加验证” → “为无效输入编写测试,然后让它们通过” “修复 bug” → “编写能复现它的测试,然后让它通过” “重构 X” → “确保测试在重构前后都能通过” 对于多步骤任务,简要陈述计划:

  1. [步骤] → 验证:[检查]
  2. [步骤] → 验证:[检查]
  3. [步骤] → 验证:[检查]

7、每次修改代码或着写代码请根据当前项目的功能、需求、代码结构等补充或者修改项目级AGENTS.md

8、单文件不超过400行代码 如果超过必须拆分

9、禁止硬编码,端口、url、配置 → 环境变量

10、新建前必须搜索有没有类似功能,有就扩展,不要重复造轮子

11、禁止静默异常,所有错误必须记录

12、禁止向后兼容,旧代码直接删除

13、尽可能要有详细的中文注释,至少每个函数都得有注释

  1. 项目级AGENTS.md文档不要超过200行,文档需要有的是项目目标、代码风格/命名/格式以及目录结构。
  2. 必须要有详细的代码注释,不能为了压缩代码行数而缺少注释

评论

评论区加载中...

本站已稳定运行: 计算中... 天 | 博客: 27 篇 | 字数: 21218
使用 Hugo 构建
主题 StackJimmy 设计