提示範例
程式碼審查
架構審查
分析此程式碼庫的架構:
1. 評估整體結構和模式
2. 識別潛在的架構問題
3. 提出改進可擴展性的建議
4. 標註遵循最佳實踐的部分
重點關注可維護性和模組化。
安全性審查
對此程式碼庫進行安全性審查:
1. 識別潛在的安全漏洞
2. 檢查常見的安全反模式
3. 審查錯誤處理和輸入驗證
4. 評估依賴項的安全性
請提供具體示例和修復步驟。
效能審查
從效能角度審查程式碼庫:
1. 識別效能瓶頸
2. 檢查資源使用情況
3. 審查算法效率
4. 評估快取策略
包含具體的優化建議。
文檔生成
API 文檔
生成全面的 API 文檔:
1. 列出並描述所有公共端點
2. 記錄請求/響應格式
3. 包含使用示例
4. 說明限制和約束
開發者指南
創建包含以下內容的開發者指南:
1. 環境搭建說明
2. 專案結構概覽
3. 開發工作流程
4. 測試方法
5. 常見問題排查步驟
架構文檔
記錄系統架構:
1. 高層概述
2. 組件交互
3. 資料流程圖
4. 設計決策及理由
5. 系統限制和約束
分析與改進
依賴項分析
分析專案依賴:
1. 識別過時的包
2. 檢查安全漏洞
3. 建議替代包
4. 審查依賴使用模式
包含具體的升級建議。
測試覆蓋率
審查測試覆蓋率:
1. 識別未測試的組件
2. 建議額外的測試用例
3. 審查測試質量
4. 推薦測試策略
程式碼質量
評估程式碼質量並提出改進建議:
1. 審查命名規範
2. 檢查程式碼組織
3. 評估錯誤處理
4. 審查註釋實踐
提供具體的良好和問題模式示例。