載入中

CLAUDE.md 檔案

第 8 課10 分鐘
載入中

CLAUDE.md 檔案

摘要逐字稿

Claude Code 中最實用的功能之一就是 CLAUDE.md 檔案。它讓 Claude Code 對您的專案擁有持久性的記憶。

它解決的問題

當您在沒有 CLAUDE.md 檔案的情況下開啟 Claude Code 時,它每次都會從頭開始。它必須重新探索您的程式碼庫、找出需要哪些相依套件,並了解哪些功能已經實作完成。有時它會做出假設,這使得引導 Claude 朝正確方向前進變得更加困難。

CLAUDE.md 解決了這個問題。它是一個您加入到專案根目錄的 Markdown 檔案,Claude Code 每次啟動工作階段時都會自動讀取它。可以把它想成是您程式碼庫的入職腳本。CLAUDE.md 檔案的內容會附加到您的提示中。

範例

以下是一個典型的 CLAUDE.md 檔案範例:

markdown
# Project

This is a Next.js 15 app using the App Router, Tailwind, and Drizzle ORM.

# Commands
- Dev server: `pnpm dev`
- Run tests: `pnpm test`
- Lint: `pnpm lint`

# Code Style
- Use 2-space indentation
- Prefer named exports
- All API routes go in app/api/
- Use server actions instead of API routes where possible

這非常直觀。現在如果您要求 Claude Code 建立一個 React 元件,它已經知道要使用 Tailwind 進行樣式設計,並遵循您的程式碼慣例。

在 VS Code 中開啟的 CLAUDE.md 檔案,顯示專案資訊、指令和程式碼風格規則

CLAUDE.md 適用於團隊

您可以(也應該)將 CLAUDE.md 提交到版本控制系統,讓您的團隊也能從中受益。實際上,根據記憶檔案的適用對象,存在一個層級結構:

  • 專案層級的 CLAUDE.md 位於您專案的根目錄中。與團隊共享。

  • 使用者層級的 CLAUDE.md 位於您的設定資料夾中。這個檔案僅供您個人使用,並適用於您所有的專案。請將您的個人偏好設定放在這裡。

小技巧

將修正內容儲存到記憶中。 如果您發現自己一再糾正 Claude——例如告訴它要一律使用伺服器動作(server actions)而非 API 路由——請明確要求 Claude 將該規則儲存到記憶中。下次您開啟專案時,它就會知道了。

要求 Claude 將規則儲存到 CLAUDE.md 檔案中——一律使用伺服器動作而非 API 路由

參照專案文件。 如果您的專案中有想讓 Claude 參照的文件,請使用 @ 符號加上檔案路徑:

markdown
## README.md

Please read if you need more info: @README.md

從空白開始。 我們建議在開始一個專案時先不要使用 CLAUDE.md 檔案,這樣您就能觀察到自己經常需要修正模型的地方。這能讓您的 CLAUDE.md 保持精簡,只聚焦於必要的資訊。當您準備好時,執行 /init 讓 Claude 為您產生一份。

總結

令人沮喪的 Claude Code 工作階段與高效率的工作階段之間的差異,往往取決於上下文——而 CLAUDE.md 檔案正是您提供這種上下文的方式。從您的技術堆疊、偏好設定和指令開始,然後隨著使用逐步建構完善。