點點學院 banner
推薦課程平台
前往點點學院,查看更多 AI 與實戰課程
如果你喜歡這篇內容,可以直接到點點學院延伸閱讀更多工具教學、工作流與實作型課程。
立即前往 →
← 回到大綱
Lesson 5-1

CLAUDE.md 的用途與最佳實務

Project Configuration with CLAUDE.md

📄 CLAUDE.md 是什麼

CLAUDE.md 是專案的「說明書」,告訴 Claude Code 這個專案的架構、規範、慣例,讓 AI 生成的程式碼符合你的風格。

✍️ 應該包含什麼

  • 📐 專案架構:資料夾結構、模組分層
  • 🎨 程式碼風格:命名規則、格式化設定
  • 📦 技術棧:使用的框架、函式庫版本
  • ⚠️ 注意事項:已知問題、特殊限制
  • 🎯 開發規範:測試要求、commit 規則

📝 範例 CLAUDE.md

# 專案:Todo App

## 架構
- Frontend: React 18 + TypeScript
- Backend: Node.js + Express
- Database: PostgreSQL
- 使用 MVC 架構

## 命名規範
- 元件:PascalCase (TodoList.tsx)
- 函式:camelCase (getTodos)
- 常數:UPPER_SNAKE_CASE (API_URL)

## 重要規則
- 所有 API 端點需加入錯誤處理
- 使用 Zod 驗證請求
- 測試覆蓋率需 > 80%
點點學院 banner
延伸閱讀
喜歡這篇內容?到點點學院看更多完整課程
從工具理解到實戰應用,點點學院整理了更多 AI、工作流與教學型內容,適合繼續往下學。
前往點點學院 →