什么值得买App下载 App ›
连续签到专享现金活动

很多人把CLAUDE.md写错了!官方建议只有一条

先说说CLAUDE.md到底是什么来头
很多人把 CLAUDE.md 当成项目介绍来写——技术栈、框架版本、项目背景,恨不得写成一篇小论文。结果呢?Claude Code 每次还是问「这个项目用什么包管理器」「测试命令是什么」。这份文件根本没起到该有的作用。CLAUDE.md 不是给人看的 README,是给 AI 看的「入职手册」。它存在的意义是让 Claude 在每次新会话开始时,不用你反复解释,就能知道项目的规矩在哪、命令怎么跑、哪些代码绝对不能碰。写对了,它是你项目里投入产出比最高的文件;写错了,就是一个占着位置却不起作用的空壳。1
官方对它的定位说得很清楚:它是「给 Claude 的持久化上下文」。每次会话启动,Claude Code 第一件事就是读取这个文件,把内容注入到系统提示词里。你写什么,它就记住什么——关键是你得写对东西。2
先搞清楚这个文件到底在干什么
一个反直觉的事实:CLAUDE.md 不是写得越多越好。上下文窗口是有限的,你往里面塞废话,真正重要的指令就被稀释了。官方建议控制在 300 行以内,社区实践普遍认为 100 行就足够。超出这个范围,Claude 对规则的遵守率会明显下降——不是靠后的规则被忽略,而是所有规则的遵循质量都在均匀下降。3
那什么该写?Anthropic 官方给出了一个筛选标准:每一行都问自己——删掉这行,Claude 会因此犯错误吗?如果不会,就删掉。这不是让你写得敷衍,而是逼你只保留那些 AI 靠自己扫描代码也推断不出来的东西。2
举个例子。「变量命名用 camelCase」不用写,Claude 本来就知道。「所有 API 请求必须走 requestClient」要写,因为这是你项目里特有的封装,AI 扫不出这个模式。「代码要整洁」也不用写,这跟对厨师说「请做好吃的菜」没区别。只写那些跟「常规做法」不一样的地方。4
CLAUDE.md到底该装些什么
根据素材总结,一份好用的 CLAUDE.md 通常包含这几类内容:项目概述(3-5 句话说清项目是什么、核心模块在哪)、技术栈与关键依赖(版本号要精确,不要模糊表述)、常用命令(构建、测试、启动,可以直接复制执行的那种)、编码规范里「反直觉」的部分(跟通用做法不一样的约定)、踩过的坑(最有价值的部分,AI 每次都会绕开你曾经踩过的地方)。5
铁律要用 IMPORTANT 或 MUST 标记,但记住:如果所有东西都标 IMPORTANT,那什么都不是 IMPORTANT 了。整个文件里通常就两三条真正需要强调的底线。剩下的只是建议,Claude 会参考但不会当成绝对命令。4
  • 适合写入的内容
    构建/测试/部署命令、目录结构和模块职责、命名规范里「反直觉」的部分、禁止事项(不要改哪些文件、不能用哪些写法)、常用库和版本约束、已知陷阱
    6

评论

评论区空态插画

当前文章无评论,是时候发表评论了