昨天實際建立了 CLAUDE.md,也開始把一些專案規則交給 Claude Code。
但建立之後,我又發現一個問題:
是不是把所有規則都寫進去,Claude Code 就會變得更好用?
答案其實不是。
如果 CLAUDE.md 寫得太簡單,AI 可能不知道我的開發習慣;但如果什麼事情都寫進去,文件變得非常長,反而可能讓 AI 抓不到真正重要的規則。
那一份好的 CLAUDE.md 到底應該寫什麼?
#模糊
- 程式碼要寫得好
- 命名要跟以前差不多
- 錯誤要好好處理
#具體
-每個funcion不要寫超過50行
-變數的名稱用其功能英文來設
-所有 throwing function 在呼叫端用 do-catch 處理,不用 try?
用Flask做,不要用Django做
用java寫,不要用c語言寫
#只有限制
- 不要使用 force unwrap
#原因
- 不要使用 force unwrap — 如果 Optional 為 nil,可能直接造成程式 Crash;請優先使用 guard let、if let 或其他安全的 Optional 處理方式
# Project Overview
## 技術架構
- Python
- Flask
- MySQL
## 開發規範
- API 使用 RESTful 設計
- 變數名稱使用具有意義的英文
- 修改程式前先確認現有架構
## Database
- 所有 SQL 都使用參數化查詢
- 不要在迴圈中重複查詢 Database
## Testing
- 修改 API 後需要執行相關測試
- 測試通過後才能回報完成
## Git
- 修改完成後先檢查 git diff
- 不要自行 commit,除非使用者要求
以上就是寫CLAUDE.md小技巧,只要能掌握,就可以使AI更好了解自己所設的規則。
明天研究主題:讓 Claude Code 先讀懂專案,再開始寫 Code