Home / Glossary / CLAUDE.md

Definition

CLAUDE.md

CLAUDE.md 是放置在專案根目錄中的 Markdown 設定檔,為 Claude Code 提供持久化的專案專屬指示。它向代理說明程式碼規範、架構、常用指令和規則,充當適用於該專案每次工作階段的長期記憶。

CLAUDE.md 的運作原理

當 Claude Code 啟動工作階段時,它會自動讀取專案根目錄中的 CLAUDE.md 檔案(以及父目錄或子目錄中的任何 CLAUDE.md 檔案)。檔案內容成為代理系統脈絡的一部分,因此代理無需每次提醒即可遵循你的指示。這使代理的行為與團隊規範保持一致。

CLAUDE.md 應包含哪些內容

  • +專案架構概覽和關鍵檔案位置
  • +程式碼規範(命名、格式、應使用或避免的模式)
  • +測試、建置和部署的常用指令
  • +「始終為新函式撰寫測試」或「不得直接修改認證模組」等規則
  • +代理應了解的技術堆疊詳情
markdown
# CLAUDE.md

## Project
Next.js 14 app with App Router, TypeScript, Tailwind CSS.

## Commands
- `npm run dev` — start dev server
- `npm test` — run Jest tests
- `npm run lint` — ESLint check

## Conventions
- Use server components by default
- Client components go in `components/client/`
- All API routes must validate input with Zod
- Write tests for every new utility function

## Do NOT
- Modify files in `lib/core/` without explicit approval
- Use `any` type in TypeScript
- Add new dependencies without justification

保持 CLAUDE.md 簡潔。代理每次工作階段都會讀取它,因此只應包含跨多個任務都相關的資訊。任務專屬的細節放在提示詞中即可。

CLAUDE.md 檔案應該放在哪裡?+
放在專案根目錄中。Claude Code 也支援子目錄中的 CLAUDE.md 檔案,用於模組專屬指示;以及父目錄中的 CLAUDE.md 檔案,用於組織層級規則。所有適用檔案會被合併。
CLAUDE.md 適用於其他 AI 工具嗎?+
CLAUDE.md 是 Claude Code 專用的。但其他一些工具也採用了類似概念。Cursor 使用 .cursorrules,其他代理可能讀取自訂設定檔。專案層級 AI 指示的概念正在成為一種通行模式。
CLAUDE.md 應該多長?+
保持在 500 行以內。聚焦於最重要的規範和規則。代理可以隨時讀取單一檔案了解詳情——CLAUDE.md 應提供跨任務適用的高層脈絡。

Related terms

Agentic 程式設計Claude Code程式碼提示工程

Master Claude Code in days, not months

37 hands-on lessons from beginner to CI/CD automation. Module 1 is free.

START FREE →
← ALL TERMS