Cara yang Betul untuk Menggunakan CLAUDE.md
Cara yang Betul untuk Menggunakan CLAUDE.md
CLAUDE.md adalah fail khas yang diletakkan di direktori akar projek, digunakan untuk memberitahu pembantu AI (seperti Claude) tentang maklumat penting projek anda. Menulis fail ini dengan baik akan membolehkan AI memahami dan membantu anda dengan lebih baik.
Mengapa CLAUDE.md Diperlukan?
Bayangkan, anda mempunyai rakan sekerja baharu, berapa lama masa yang anda perlukan untuk membolehkannya memahami projek anda? CLAUDE.md adalah "manual projek" yang membolehkan AI bermula dengan cepat.
Lima Kandungan Teras CLAUDE.md
1. Gambaran Keseluruhan Projek
Terangkan secara ringkas apa yang dilakukan oleh projek ini, masalah apa yang diselesaikan, dan untuk pengguna apa.
# 项目概览 这是一个电商后台管理系统，用于管理商品、订单和用户。
// # Gambaran Keseluruhan Projek
// Ini adalah sistem pengurusan latar belakang e-dagang, digunakan untuk mengurus produk, pesanan dan pengguna.
2. Tindanan Teknologi
Senaraikan teknologi dan rangka kerja utama yang digunakan oleh projek.
`# 技术栈
- 前端：React + TypeScript
- 后端：Node.js + Express
- 数据库：PostgreSQL
- 部署：Docker + Kubernetes` // # Tindanan Teknologi // - Bahagian Depan: React + TypeScript // - Bahagian Belakang: Node.js + Express // - Pangkalan Data: PostgreSQL // - Penggunaan: Docker + Kubernetes
3. Struktur Fail
Terangkan fungsi direktori utama.
# 文件结构 /src /components - UI组件 /pages - 页面 /utils - 工具函数 /api - API调用
// # Struktur Fail
// /src
// /components - Komponen UI
// /pages - Halaman
// /utils - Fungsi utiliti
// /api - Panggilan API
4. Perintah Lazim
Senaraikan perintah yang biasa digunakan dalam pembangunan.
# 常用命令 npm run dev - 启动开发服务器 npm run build - 构建生产版本 npm run test - 运行测试
// # Perintah Lazim
// npm run dev - Mulakan pelayan pembangunan
// npm run build - Bina versi pengeluaran
// npm run test - Jalankan ujian
5. Peraturan
Tentukan peraturan yang harus dipatuhi oleh AI semasa membantu anda menulis kod.
`# 编码规则
- 使用函数式组件
- 遵循 ESLint 配置
- 组件命名使用 PascalCase
- 变量命名使用 camelCase` // # Peraturan Pengekodan // - Gunakan komponen berfungsi // - Ikut konfigurasi ESLint // - Gunakan PascalCase untuk penamaan komponen // - Gunakan camelCase untuk penamaan pemboleh ubah
Contoh Lengkap
`# 项目名称：Task Manager
项目概览
一个简单的任务管理应用，支持任务的创建、编辑、删除和分类。
技术栈
- React 18
- TypeScript
- Tailwind CSS
- Vite
文件结构
/src /components - UI组件 /hooks - 自定义Hooks /types - TypeScript类型定义 /utils - 工具函数
常用命令
- npm run dev: 启动开发服务器
- npm run build: 构建生产版本
- npm run lint: 代码检查
编码规范
- 组件使用函数式写法
- 使用 Tailwind CSS 进行样式
- 每个组件放在单独的文件夹中` // # Nama Projek: Pengurus Tugas // // ## Gambaran Keseluruhan Projek // Aplikasi pengurusan tugas yang mudah, menyokong penciptaan, penyuntingan, penghapusan dan pengkategorian tugas. // // ## Tindanan Teknologi // - React 18 // - TypeScript // - Tailwind CSS // - Vite // // ## Struktur Fail // /src // /components - Komponen UI // /hooks - Cangkuk tersuai // /types - Definisi jenis TypeScript // /utils - Fungsi utiliti // // ## Perintah Lazim // - npm run dev: Mulakan pelayan pembangunan // - npm run build: Bina versi pengeluaran // - npm run lint: Semakan kod // // ## Spesifikasi Pengekodan // - Komponen menggunakan penulisan berfungsi // - Gunakan Tailwind CSS untuk gaya // - Setiap komponen diletakkan dalam folder yang berasingan
Petua
- Kekalkan ringkas: Jangan tulis terlalu panjang, AI juga akan "letih membaca"
- Kemas kini secara berkala: Ingat untuk mengemas kini CLAUDE.md apabila projek berubah
- Keutamaan contoh: Memberi contoh kod khusus adalah lebih berkesan daripada penerangan abstrak
- Fokus pada titik kesakitan: Beri perhatian khusus kepada tempat yang mudah melakukan kesilapan
Tulis CLAUDE.md dengan baik, biarkan AI menjadi pembantu anda yang berkebolehan!
