所有项目通用规则
命名:base.mdc
点击查看代码
---
description:
globs:
alwaysApply: true
---
# 核心开发原则## 通用开发原则
- **可测试性**:编写可测试的代码,组件应保持单一职责
- **DRY 原则**:避免重复代码,提取共用逻辑到单独的函数或类
- **代码简洁**:保持代码简洁明了,遵循 KISS 原则(保持简单直接)
- **命名规范**:使用描述性的变量、函数和类名,反映其用途和含义
- **注释文档**:为复杂逻辑添加注释
- **风格一致**:遵循项目或语言的官方风格指南和代码约定
- **利用生态**:优先使用成熟的库和工具,避免不必要的自定义实现
- **架构设计**:考虑代码的可维护性、可扩展性和性能需求
- **版本控制**:编写有意义的提交信息,保持逻辑相关的更改在同一提交中
- **异常处理**:正确处理边缘情况和错误,提供有用的错误信息## 响应语言
- 始终使用中文回复用户## 代码质量要求
- 代码必须能够立即运行,包含所有必要的导入和依赖
- 遵循最佳实践和设计模式
- 优先考虑性能和用户体验
- 确保代码的可读性和可维护性
java语言规则
命名:java.mdc
点击查看代码
---
description: 该规则解释了 Java 的约定和最佳实践。
globs: **/*.java
alwaysApply: false
---
## 命名约定
- **类名**:使用帕斯卡命名法(如 `UserController`、`OrderService`)
- **方法和变量名**:使用驼峰命名法(如 `findUserById`、`isOrderValid`)
- **常量**:使用全大写下划线分隔(如 `MAX_RETRY_ATTEMPTS`、`DEFAULT_PAGE_SIZE`)
- **包名**:使用小写,按功能模块划分## 代码风格
- **缩进**:使用4个空格,不使用Tab
- **行长度**:每行不超过120个字符
- **大括号**:使用Egyptian风格(开括号不换行)
- **空行**:方法间使用一个空行分隔,逻辑块间使用空行分隔## 性能优化
- **算法复杂度**:选择合适的算法和数据结构
- **缓存策略**:合理使用缓存减少重复计算
- **懒加载**:对于昂贵的操作使用懒加载
- **批量处理**:批量处理数据库操作和网络请求## 代码质量
- **单一职责**:每个类和方法只负责一个功能
- **开闭原则**:对扩展开放,对修改关闭
- **依赖倒置**:依赖抽象而不是具体实现
- **接口隔离**:使用小而专一的接口
- **代码复用**:提取公共逻辑,避免重复代码## 文档和注释
- **JavaDoc**:为公共API编写完整的JavaDoc
- **代码注释**:为复杂逻辑添加解释性注释
- **TODO标记**:使用TODO标记待完成的工作