🤫 让你的 AI 编码速度翻倍的秘密 .md 文件

发布: (2026年1月18日 GMT+8 09:18)
5 min read
原文: Dev.to

Source: Dev.to

插图

停止重复自己。

如果你在每次聊天开始时都输入 “Please use TypeScript and Tailwind”,那你在 AI 开发上走了弯路。

我们都经历过:打开一个新的 Claude 3.5 Sonnet(或 ChatGPT)会话,粘贴错误日志,AI 自信地给出一个 Python 修复方案。
你的项目是 Rust,于是你纠正它。接着它又给出 Rust 修复,但使用了过时的库。经过几轮来回,你已经浪费了数分钟和成千上万的 token。

还有更好的办法。Builder.io 团队使用了一个简单的技巧——为你的 LLM 准备的 “Context Cheat Sheet”,即 CLAUDE.md 文件。

什么是 CLAUDE.md

CLAUDE.md 看作是 机器人版 README
普通的 README.md 面向人类,充满徽章和营销文案。
CLAUDE.md 面向 AI:信息密集、事实性强,恰好包含模型立即开始编码所需的全部内容。把这个文件(或其内容)放在会话开始时,AI 就能获得关于你的仓库的 “高级工程师” 级别的上下文。

完美的 CLAUDE.md 模板

根据 Builder.io 的指南,高性能的上下文文件应包含四个独立章节。

1. 构建与运行命令

明确告诉 AI 如何启动、测试和构建项目。

## Commands
- Run Dev: `npm run dev`
- Run Tests: `npm test`
- Build: `npm run build`
- Database: `docker-compose up -d db`

2. 编码规范(“禁区”)

防止 AI 使用不良模式。

## Code Style
- Use TypeScript for all new files.
- Prefer functional components over class components.
- Styling: Use Tailwind CSS utility classes (no CSS modules).
- State Management: Use Zustand, DO NOT use Redux.
- Error Handling: Use try/catch blocks in all async functions.

3. 架构概览

为 AI 提供项目结构的思维导图。

## Architecture
- /src/components: Reusable UI atoms.
- /src/features: Domain‑specific business logic.
- /src/hooks: Custom React hooks.
- **Rule**: Business logic should NEVER exist inside UI components. Move it to a custom hook.

4. 技术栈定义

列出所有主要库,防止 AI 幻想出不存在的导入。

## Tech Stack
- Frontend: Next.js 14 (App Router)
- UI: Shadcn UI + Lucide Icons
- DB: Supabase
- Auth: Clerk

为什么这能改变一切

当你在会话开始时把这个文件喂给 Claude(或将其添加到 Claude Projects 的 “Project Knowledge” 中),会发生三件事:

  • 零样本准确性:AI 立刻写出符合你风格的代码——无需再把 const 改成 var,或补上缺失的类型。
  • 减少幻觉:明确的库列表阻止了像在已经使用 fetch 时仍建议安装 axios 之类的错误建议。
  • 入职辅助:新开发者可以阅读 CLAUDE.md,快速掌握严格的技术指南,而不被冗余信息干扰。

自动注入上下文

你可以自动将文件复制到剪贴板。创建脚本 copy-context.sh

# macOS / Linux
cat CLAUDE.md | pbcopy
echo "Context copied to clipboard!"

运行 ./copy-context.sh,粘贴到 Claude 中,然后说类似 “Let’s refactor the login component.” 的话。它就能直接工作。

未来:.ai 文件?

我们正迈向 AI 原生仓库。正如我们为 Git 有 .gitignore,为 Docker 有 .dockerignore,每个仓库很快也会需要专门为 AI 代理准备的配置文件。

无论你把它称作 .cursorrulesCLAUDE.md 还是 context.txt,原则都是一样的:上下文为王

今天就在你的项目中创建一个 CLAUDE.md ——以后你会感谢自己的。

Back to Blog

相关文章

阅读更多 »

Rapg:基于 TUI 的密钥管理器

我们都有这种经历。你加入一个新项目,首先听到的就是:“在 Slack 的置顶消息里查找 .env 文件”。或者你有多个 .env …

技术是赋能者,而非救世主

为什么思考的清晰度比你使用的工具更重要。Technology 常被视为一种魔法开关——只要打开,它就能让一切改善。新的 software,...

踏入 agentic coding

使用 Copilot Agent 的经验 我主要使用 GitHub Copilot 进行 inline edits 和 PR reviews,让我的大脑完成大部分思考。最近我决定 t...